You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fixed the path location for macOS.
Added information about the toolchain installation location.
NCSIDB-1414.
Signed-off-by: Grzegorz Ferenc <[email protected]>
Copy file name to clipboardExpand all lines: doc/nrf/installation/install_ncs.rst
+22-7Lines changed: 22 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,9 @@ Depending on your preferred development environment, complete the following step
144
144
145
145
This example command installs the toolchain required for the |NCS| v2.0.0.
146
146
147
-
The toolchain is installed by default at :file:`C:/ncs/toolchains` on Windows, :file:`~/ncs/toolchains` on Linux, and :file:`/opt/nordic/ncs/toolchains` on macOS.
147
+
The ``toolchain-manager`` command installs the toolchain by default at :file:`C:/ncs/toolchains` on Windows and at :file:`~/ncs/toolchains` on Linux.
148
+
These can be modified, as explained in the `Toolchain Manager command`_ documentation.
149
+
On macOS, :file:`/opt/nordic/ncs/toolchains` is used and no other location is allowed.
148
150
149
151
If you have received a custom URL for installing the toolchain, you can use the following command to set it as default, replacing the respective parameter:
150
152
@@ -163,6 +165,16 @@ Depending on your preferred development environment, complete the following step
163
165
To check the current configuration setting, use the ``nrfutil toolchain-manager config --show`` command.
164
166
To read more about these commands, use the ``nrfutil toolchain-manager --help`` command.
165
167
168
+
With the default location to install the toolchain (:file:`C:/ncs/toolchains` on Windows, :file:`~/ncs/toolchains/` on Linux, and the non-modifiable :file:`/opt/nordic/ncs/toolchains/` on macOS), your directory structure now looks similar to this:
169
+
170
+
.. code-block:: none
171
+
172
+
ncs
173
+
└─── toolchains
174
+
└─── <toolchain-installation>
175
+
176
+
In this simplified structure preview, *<toolchain-installation>* corresponds to the version name you installed (most commonly, a SHA).
177
+
166
178
You can check the versions of the required tools and Python dependencies on the :ref:`Requirements reference page <requirements_toolchain>`.
167
179
168
180
.. _cloning_the_repositories_win:
@@ -255,28 +267,31 @@ For more information about the repository and development model, see the :ref:`d
255
267
.. parsed-literal::
256
268
:class: highlight
257
269
258
-
west init -m https\://github.com/nrfconnect/sdk-nrf --mr *nRFConnectSDK_revision*
270
+
west init -m https\://github.com/nrfconnect/sdk-nrf --mr *nRFConnectSDK_revision* *nRFConnectSDK_revision*
271
+
272
+
In this command, the first *nRFConnectSDK_revision* identifies the revision of the |NCS| and the second *nRFConnectSDK_revision* is the name of the workspace directory that will be created by west.
259
273
274
+
The command creates the *nRFConnectSDK_revision* subdirectory and checks out the given revision of the |NCS| inside it.
260
275
For example:
261
276
262
277
* **Specific release:** To check out the |release| release, enter the following command:
263
278
264
279
.. parsed-literal::
265
280
:class: highlight
266
281
267
-
west init -m https\://github.com/nrfconnect/sdk-nrf --mr |release|
282
+
west init -m https\://github.com/nrfconnect/sdk-nrf --mr |release| |release|
268
283
269
284
* **Development tag:** To check out the ``v1.9.2-dev1`` tag, enter the following command:
270
285
271
286
.. code-block:: console
272
287
273
-
west init -m https://github.com/nrfconnect/sdk-nrf --mr v1.9.2-dev1
288
+
west init -m https://github.com/nrfconnect/sdk-nrf --mr v1.9.2-dev1 v1.9.2-dev1
274
289
275
290
* **Branch**: To check out the ``main`` branch that includes the latest state of development, enter the following command:
276
291
277
292
.. code-block:: console
278
293
279
-
west init -m https://github.com/nrfconnect/sdk-nrf --mr main
294
+
west init -m https://github.com/nrfconnect/sdk-nrf --mr main main
280
295
281
296
This will clone the manifest repository `sdk-nrf`_ into :file:`nrf`.
282
297
@@ -308,7 +323,7 @@ For more information about the repository and development model, see the :ref:`d
308
323
309
324
..
310
325
311
-
If you used the default locations (:file:`C:/ncs` on Windows, :file:`<home>/ncs` on Linux and MacOS), your directory structure now looks similar to this:
326
+
With the default location to install the toolchain (see the previous step) and the default location to install the SDK (:file:`C:/ncs` on Windows, :file:`~/ncs/` on Linux, and :file:`/opt/nordic/ncs/` on macOS), your directory structure now looks similar to this:
312
327
313
328
.. code-block:: none
314
329
@@ -324,7 +339,7 @@ If you used the default locations (:file:`C:/ncs` on Windows, :file:`<home>/ncs`
324
339
├─── zephyr
325
340
└─── ...
326
341
327
-
In this simplified structure preview, *<home>* corresponds to :file:`ncs/` and *<toolchain-installation>* and *<west-workspace>* correspond to the version names you installed.
342
+
In this simplified structure preview, *<toolchain-installation>* corresponds to the toolchain version and *<west-workspace>* corresponds to the SDK version name.
328
343
There are also additional directories, and the structure might change over time, for example if you later :ref:`change the state of development to a different revision <updating_repos>`.
329
344
The full set of repositories and directories is defined in the :ref:`manifest file <zephyr:west-manifest-files>` (`see the file in the repository <west manifest file_>`_).
.. _`DFU over a serial USB connection`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-a-serial-usb-connection
Copy file name to clipboardExpand all lines: doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -690,4 +690,4 @@ cJSON
690
690
Documentation
691
691
=============
692
692
693
-
|no_changes_yet_note|
693
+
* Fixed an issue on the :ref:`install_ncs` page where an incorrect directory path was provided for Linux and macOS at the end of the :ref:`cloning_the_repositories_win` section.
0 commit comments