Skip to content

Commit

Permalink
doc: install_ncs: update path location for macOS
Browse files Browse the repository at this point in the history
Fixed the path location for macOS.
Added information about the toolchain installation location.
NCSIDB-1414.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer authored and carlescufi committed Nov 29, 2024
1 parent 709f20d commit 9faad15
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 9 deletions.
29 changes: 22 additions & 7 deletions doc/nrf/installation/install_ncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,9 @@ Depending on your preferred development environment, complete the following step
This example command installs the toolchain required for the |NCS| v2.0.0.

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.
The ``toolchain-manager`` command installs the toolchain by default at :file:`C:/ncs/toolchains` on Windows and at :file:`~/ncs/toolchains` on Linux.
These can be modified, as explained in the `Toolchain Manager command`_ documentation.
On macOS, :file:`/opt/nordic/ncs/toolchains` is used and no other location is allowed.

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:

Expand All @@ -163,6 +165,16 @@ Depending on your preferred development environment, complete the following step
To check the current configuration setting, use the ``nrfutil toolchain-manager config --show`` command.
To read more about these commands, use the ``nrfutil toolchain-manager --help`` command.

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:

.. code-block:: none
ncs
└─── toolchains
└─── <toolchain-installation>
In this simplified structure preview, *<toolchain-installation>* corresponds to the version name you installed (most commonly, a SHA).

You can check the versions of the required tools and Python dependencies on the :ref:`Requirements reference page <requirements_toolchain>`.

.. _cloning_the_repositories_win:
Expand Down Expand Up @@ -255,28 +267,31 @@ For more information about the repository and development model, see the :ref:`d
.. parsed-literal::
:class: highlight
west init -m https\://github.com/nrfconnect/sdk-nrf --mr *nRFConnectSDK_revision*
west init -m https\://github.com/nrfconnect/sdk-nrf --mr *nRFConnectSDK_revision* *nRFConnectSDK_revision*
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.

The command creates the *nRFConnectSDK_revision* subdirectory and checks out the given revision of the |NCS| inside it.
For example:

* **Specific release:** To check out the |release| release, enter the following command:

.. parsed-literal::
:class: highlight
west init -m https\://github.com/nrfconnect/sdk-nrf --mr |release|
west init -m https\://github.com/nrfconnect/sdk-nrf --mr |release| |release|
* **Development tag:** To check out the ``v1.9.2-dev1`` tag, enter the following command:

.. code-block:: console
west init -m https://github.com/nrfconnect/sdk-nrf --mr v1.9.2-dev1
west init -m https://github.com/nrfconnect/sdk-nrf --mr v1.9.2-dev1 v1.9.2-dev1
* **Branch**: To check out the ``main`` branch that includes the latest state of development, enter the following command:

.. code-block:: console
west init -m https://github.com/nrfconnect/sdk-nrf --mr main
west init -m https://github.com/nrfconnect/sdk-nrf --mr main main
This will clone the manifest repository `sdk-nrf`_ into :file:`nrf`.

Expand Down Expand Up @@ -308,7 +323,7 @@ For more information about the repository and development model, see the :ref:`d
..
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:
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:

.. code-block:: none
Expand All @@ -324,7 +339,7 @@ If you used the default locations (:file:`C:/ncs` on Windows, :file:`<home>/ncs`
├─── zephyr
└─── ...
In this simplified structure preview, *<home>* corresponds to :file:`ncs/` and *<toolchain-installation>* and *<west-workspace>* correspond to the version names you installed.
In this simplified structure preview, *<toolchain-installation>* corresponds to the toolchain version and *<west-workspace>* corresponds to the SDK version name.
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>`.
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_>`_).

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,7 @@
.. _`DFU over Zigbee`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-zigbee
.. _`Generating DFU packages`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_generating_packages.html
.. _`DFU over a serial USB connection`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-a-serial-usb-connection
.. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html#available-subcommands
.. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html
.. _`Recovering the device`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_recovery.html
.. _`nrfutil-trace`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/CHANGELOG.html
.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -690,4 +690,4 @@ cJSON
Documentation
=============

|no_changes_yet_note|
* 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 comments on commit 9faad15

Please sign in to comment.