Skip to content

Commit c55ed9b

Browse files
greg-ferrlubos
authored andcommitted
doc: install: sdk-manager commands
Replaced toolchain-manager commands with corresponding sdk-manager ones. NRFU-1453. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
1 parent 7f7f48c commit c55ed9b

File tree

4 files changed

+26
-19
lines changed

4 files changed

+26
-19
lines changed

doc/nrf/installation/install_ncs.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -101,56 +101,56 @@ Depending on your preferred development environment, complete the following step
101101
.. group-tab:: Command line
102102

103103
1. Open a terminal window.
104-
#. Run the following command to install the nRF Util ``toolchain-manager`` command:
104+
#. Run the following command to install the nRF Util's ``sdk-manager`` command:
105105

106106
.. code-block:: console
107107
108-
nrfutil install toolchain-manager
108+
nrfutil install sdk-manager
109109
110110
#. Run the following command to list the available installations:
111111

112112
.. code-block:: console
113113
114-
nrfutil toolchain-manager search
114+
nrfutil sdk-manager search
115115
116116
The versions from this list correspond to the |NCS| versions and will be *version* in the following step.
117117
#. Run the following command to install the toolchain version for the SDK version of your choice:
118118

119119
.. parsed-literal::
120120
:class: highlight
121121
122-
nrfutil toolchain-manager install --ncs-version *version*
122+
nrfutil sdk-manager toolchain install --ncs-version *version*
123123
124124
For example:
125125

126126
.. parsed-literal::
127127
:class: highlight
128128
129-
nrfutil toolchain-manager install --ncs-version |release|
129+
nrfutil sdk-manager toolchain install --ncs-version |release|
130130
131131
This example command installs the toolchain required for the |NCS| |release|.
132132
|install_latest_version|
133133

134-
The ``toolchain-manager`` command installs the toolchain by default at :file:`C:/ncs/toolchains` on Windows and at :file:`~/ncs/toolchains` on Linux.
135-
These can be modified, as explained in the `Toolchain Manager command`_ documentation.
136-
To check the current configuration setting, use the ``nrfutil toolchain-manager config --show`` command.
134+
The ``sdk-manager`` command installs the toolchain by default at :file:`C:/ncs/toolchains` on Windows and at :file:`~/ncs/toolchains` on Linux.
135+
These can be modified, as explained in the `command documentation <sdk-manager Configuration settings_>`_.
137136
On macOS, :file:`/opt/nordic/ncs/toolchains` is used and no other location is allowed.
138137

139-
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:
138+
If you have received a custom URL for installing the toolchain, you can use the following commands to set it as default, replacing the respective parameters:
140139

141140
.. parsed-literal::
142141
:class: highlight
143142
144-
nrfutil toolchain-manager config --set toolchain-index=\ *custom_toolchain_URL*
143+
nrfutil sdk-manager config toolchain-index add *index-name* *custom_toolchain_URL*
144+
nrfutil sdk-manager config toolchain-index set *index-name*
145145
146146
If you have received a custom bundle ID for installing a specific toolchain version, you can use the following commands to provide it, replacing the respective parameter:
147147

148148
.. parsed-literal::
149149
:class: highlight
150150
151-
nrfutil toolchain-manager install --bundle-id *custom_bundle_ID*
151+
nrfutil sdk-manager toolchain install --toolchain-bundle-id *custom_bundle_ID*
152152
153-
To read more about ``toolchain-manager`` commands, use the ``nrfutil toolchain-manager --help`` command.
153+
To read more about ``sdk-manager`` commands, use the ``nrfutil sdk-manager --help`` command, or see the `command documentation <sdk-manager command_>`_.
154154

155155
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:
156156

@@ -229,19 +229,19 @@ For more information about the repository and development model, see the :ref:`d
229229

230230
.. code-block:: console
231231
232-
nrfutil toolchain-manager launch --terminal
232+
nrfutil sdk-manager toolchain launch --terminal
233233
234234
.. tab:: Linux
235235

236236
.. code-block:: console
237237
238-
nrfutil toolchain-manager launch --shell
238+
nrfutil sdk-manager toolchain launch --shell
239239
240240
.. tab:: macOS
241241

242242
.. code-block:: console
243243
244-
nrfutil toolchain-manager launch --shell
244+
nrfutil sdk-manager toolchain launch --shell
245245
246246
..
247247

doc/nrf/installation/recommended_versions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,8 @@ Use the latest available release for development.
415415

416416
When you :ref:`install the nRF Connect SDK <install_ncs>`, you need to install the following nRF Util commands:
417417

418-
* `Device command <Device command overview_>`_ (``device``) - The latest version is required as the default :ref:`west runner <programming_selecting_runner>`.
419-
* `Toolchain Manager command`_ (``toolchain-manager``) - The latest version is required for working with |NCS| toolchain packages.
418+
* `device command <Device command overview_>`_ - The latest version is required as the default :ref:`west runner <programming_selecting_runner>`.
419+
* `sdk-manager command`_ - The latest version is required for working with |NCS| toolchain packages.
420420
You only need to install this command if you are working with command line in the |NCS|.
421421

422422
See `Installing and upgrading nRF Util commands`_ for information about how to install these commands.

doc/nrf/links.txt

+2
Original file line numberDiff line numberDiff line change
@@ -916,6 +916,8 @@
916916
.. _`Generating DFU packages`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_generating_packages.html
917917
.. _`DFU over a serial USB connection`: https://docs.nordicsemi.com/bundle/nrfutil/page/guides-nrf5sdk/dfu_performing.html#dfu-over-a-serial-usb-connection
918918
.. _`Toolchain Manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-toolchain-manager/nrfutil-toolchain-manager_0.14.1.html
919+
.. _`sdk-manager command`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-sdk-manager/nrfutil-sdk-manager.html
920+
.. _`sdk-manager Configuration settings`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-sdk-manager/sdk_manager_config_settings.html
919921
.. _`Recovering the device`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-device/guides/programming_recovery.html
920922
.. _`nrfutil-trace`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-trace/CHANGELOG.html
921923
.. _`nRF Sniffer for Bluetooth LE`: https://docs.nordicsemi.com/bundle/nrfutil/page/nrfutil-ble-sniffer/guides/overview.html

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,13 @@ IDE, OS, and tool support
3636
* Updated:
3737

3838
* The required `SEGGER J-Link`_ version to v8.18.
39-
* The :ref:`installing_vsc` section on the :ref:`installation` page with a list valid for both development environments.
40-
The list now includes nRF Util as an additional requirement for :ref:`west runner <programming_selecting_runner>` for the |nRFVSC|, and the Windows-only requirement to install SEGGER USB Driver for J-Link for both development environments.
39+
* The :ref:`installation` page with the following updates:
40+
41+
* The :ref:`installing_vsc` section with a list valid for both development environments.
42+
The list now includes nRF Util as an additional requirement for :ref:`west runner <programming_selecting_runner>` for the |nRFVSC|, and the Windows-only requirement to install SEGGER USB Driver for J-Link for both development environments.
43+
* The command-line instructions now use the ``nrfutil sdk-manager`` command instead of the ``nrfutil toolchain-manager`` command.
44+
You can read more about the new command in the `nRF Util documentation <sdk-manager command_>`_.
45+
4146

4247
Board support
4348
=============

0 commit comments

Comments
 (0)