Installing the nRF Connect SDK Step 4 Get the nRF SDK Connect code step 1 is misleading

[Burt]

The instructions are: On the command line, open the directory ncs. The following steps have one do a west init directly in the directory ncs. But they should say to create a directory below ncs that is identical to the nRFConnectSDK_revision and cd to that directory prior to doing west init and west update. The existing instructions are inconsistent with the diagram below step 6. And inconsistent with every other method you have for setting up a west workspace. Can you fix the documentation? I know it has been this way for many years; always incorrect, AFAICT. Thanks.

Burt Silverman

[Øyvind]

Hello Burt, 

Could you please provide direct links and examples (screenshots) to what you are referring to? This would make it easier to explain what should be fixed. If this is wrong, what error message are you receiving on your end?

Thanks.

Kind regards,
Øyvind

[Burt]

Hi Oyvind,

This is the page: Installing the nRF Connect SDK. You will see this statement 

1. On the command line, open the directory ncs. By default, this is one level up from the location where you installed the toolchain. This directory will hold all nRF Connect SDK repositories.

under major Part 4 Get the NRF Connect SDK Code. That statement does agree with the procedure they specify. HOWEVER, then they show a diagram

If you used the default locations (C:/ncs on Windows, <home>/ncs on Linux and MacOS), your directory structure now looks similar to this:

If you used the default locations (C:/ncs on Windows, <home>/ncs on Linux and MacOS), your directory structure now looks similar to this:

Explain this code
Copy
Copy

ncs
├─── toolchains
│ └─── <toolchain-installation>
└─── <west-workspace>
├─── .west
├─── bootloader
├─── modules
├─── nrf
├─── nrfxlib
├─── zephyr
└─── ...

If I am not mistaken, this is showing ncs/<west-workspace>/{.west},{bootloader},{modules},{nrf}...,{zephyr}

Where <west-workspace> could be something like v2.8.0. And that is what everybody (most everybody) wants, but the procedure puts all those directories .west...zephyr directly underneath ncs. This is fine until one wants to have more than one west-workspace at the same time, like v2.7.0 and v2.8.0. Then one ends up with a big mess.

Burt

[Øyvind]

Hi Burt, thanks for clarifying. I've forwarded internally to get a comment to this. 

Note, that for best/quickest fix to the issue it would be nice if you could report this through the Feedback button on the right hand side.

Kind regards,
Øyvind

[Burt]

Thanks, Oyvind, for the heads up on the Feedback button. I am so used to opening tickets here I never noticed/thought about the button.

I look forward to the comments.

Burt