Skip to content

Commit 1092cfa

Browse files
greg-ferrlubos
authored andcommitted
doc: nrfvsc: edits to general docs
Edited sections about the nRF Connect for VSC in the general docs. Edited information about which apps sysbuild is enabled by default for. VSC-2711. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 71b5316 commit 1092cfa

File tree

5 files changed

+34
-15
lines changed

5 files changed

+34
-15
lines changed

doc/nrf/app_dev/config_and_build/building.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@ Just as for creating the application, you can build the application using either
1616

1717
.. group-tab:: nRF Connect for VS Code
1818

19-
For instructions about building with the |nRFVSC|, see `How to build an application`_ in the extension documentation.
19+
To build with the |nRFVSC|, you first need to create a build configuration.
20+
For instructions, see `How to build an application`_ in the extension documentation.
2021

2122
By default, the extension runs both stages of the CMake build (:ref:`configuration phase and building phase <app_build_system>`).
2223
If you want to only set up the build configuration without building it, make sure the :guilabel:`Build after generating configuration` is not selected.
2324

24-
To build with :ref:`configuration_system_overview_sysbuild`, select the :guilabel:`Use sysbuild` checkbox.
25+
To build with :ref:`configuration_system_overview_sysbuild`, :ref:`keep the default setting selected <sysbuild_enabled_ncs>` or select the :guilabel:`Use sysbuild` radio button.
2526

2627
If you want to build with custom options or scripts, read about `Binding custom tasks to actions`_ in the extension documentation.
2728

doc/nrf/app_dev/config_and_build/cmake/index.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,12 +115,14 @@ This is how you can specify them:
115115
See `How to build an application`_ in the |nRFVSC| documentation.
116116
You can specify the additional configuration variables when `setting up a build configuration <How to build an application_>`_:
117117

118-
* :makevar:`FILE_SUFFIX` (and :makevar:`CONF_FILE`) - Select the configuration in the :guilabel:`Configuration` menu.
119-
* :makevar:`EXTRA_CONF_FILE` - Add the Kconfig fragment file in the :guilabel:`Kconfig fragments` menu.
120-
* :makevar:`EXTRA_DTC_OVERLAY_FILE` - Add the devicetree overlays in the :guilabel:`Devicetree overlays` menu.
118+
* :makevar:`FILE_SUFFIX` (and :makevar:`CONF_FILE`) - Select the configuration in the :guilabel:`Base configuration files` menu.
119+
* :makevar:`EXTRA_CONF_FILE` - Add the Kconfig fragment file in the :guilabel:`Extra Kconfig fragments` menu.
120+
* :makevar:`DTC_OVERLAY_FILE` - Select the configuration in the :guilabel:`Base devicetree overlays` menu.
121+
* :makevar:`EXTRA_DTC_OVERLAY_FILE` - Add the devicetree overlays in the :guilabel:`Extra devicetree overlays` menu.
122+
* :makevar:`SNIPPET` - Select the snippet from the list in the :guilabel:`Snippets` menu.
121123
* Other variables - Provide CMake arguments in the :guilabel:`Extra CMake arguments` field, preceded by ``--``.
122124

123-
For example, to build the :ref:`location_sample` sample for the nRF9161 DK with the nRF7002 EK Wi-Fi support, select ``nrf9161dk/nrf9161/ns`` in the :guilabel:`Board` menu, :file:`overlay-nrf7002ek-wifi-scan-only.conf` in the :guilabel:`Kconfig fragments` menu, and provide ``-- -DSHIELD=nrf7002ek`` in the :guilabel:`Extra CMake arguments` field.
125+
For example, to build the :ref:`location_sample` sample for the nRF9161 DK with the nRF7002 EK Wi-Fi support, select ``nrf9161dk/nrf9161/ns`` in the :guilabel:`Board` menu, :file:`overlay-nrf7002ek-wifi-scan-only.conf` in the :guilabel:`Extra Kconfig fragments` menu, and provide ``-- -DSHIELD=nrf7002ek`` in the :guilabel:`Extra CMake arguments` field.
124126

125127
.. group-tab:: Command line
126128

doc/nrf/app_dev/config_and_build/config_and_build_system.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -273,12 +273,13 @@ Sysbuild enabled by default
273273

274274
:ref:`configuration_system_overview_sysbuild` in the |NCS| works differently than in Zephyr.
275275

276-
The |NCS| `modifies the default behavior <sdk-zephyr west build patch_>`_ of ``west build``, so that the :ref:`standard building procedure <building>` will use sysbuild by default for :ref:`repository applications <create_application_types_repository>` in the :ref:`SDK repositories <dm_repo_types>`.
276+
The |NCS| `modifies the default behavior <sdk-zephyr west build patch_>`_ of ``west build``: the :ref:`standard building procedure <building>` in the |NCS| uses sysbuild by default for all types of applications in the :ref:`SDK repositories <dm_repo_types>`.
277+
This includes :ref:`repository applications <create_application_types_repository>` and the out-of-tree applications (:ref:`workspace <create_application_types_workspace>` and :ref:`freestanding applications <create_application_types_freestanding>`).
278+
277279
For this reason, unlike in Zephyr, ``--sysbuild`` does not have to be explicitly mentioned in the command prompt when building a repository application.
278280
This setting only applies to repositories delivered with the |NCS|, to maintain compatibility with child/parent images.
279281

280-
This setting does not apply to out-of-tree applications, such as :ref:`workspace <create_application_types_workspace>` or :ref:`freestanding applications <create_application_types_freestanding>`.
281-
In such cases, once you ported your application to sysbuild, it is up to you to either use the ``--sysbuild`` parameter on the command line every time you build or to :ref:`configure west to always use it <sysbuild_enabled_ncs_configuring>`.
282+
If you want to disable this feature, for example if you want to explicitly use the ``--sysbuild`` parameter on the command line every time you build, :ref:`configure west to disable this default setting <sysbuild_enabled_ncs_configuring>`.
282283

283284
Moreover, this |NCS| setting does not apply to the following areas:
284285

doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_configuring_west.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,23 @@
33
Configuring sysbuild usage in west
44
##################################
55

6-
The |NCS| has :ref:`sysbuild enabled by default <sysbuild_enabled_ncs>` for for :ref:`repository applications <create_application_types_repository>` in the :ref:`SDK repositories <dm_repo_types>`.
6+
The |NCS| has :ref:`sysbuild enabled by default <sysbuild_enabled_ncs>` for :ref:`all types of applications <create_application_types>` in the :ref:`SDK repositories <dm_repo_types>`.
77

8-
If you work with out-of-tree applications, such as :ref:`workspace <create_application_types_workspace>` or :ref:`freestanding applications <create_application_types_freestanding>`, you can configure your project to use sysbuild by default whenever invoking ``west build``.
8+
You can configure your project to not sysbuild by default whenever invoking ``west build``.
99
You can do this either per-workspace, using the local configuration option, or for all your workspaces, using the global configuration option:
1010

1111
.. tabs::
1212

1313
.. group-tab:: Local sysbuild configuration
1414

15-
Use the following command to configure west to use sysbuild by default for building all projects in the current workspace (including any freestanding applications that are built against it):
15+
Use the following command to configure west not to use sysbuild by default for building all projects in the current workspace:
16+
17+
.. parsed-literal::
18+
:class: highlight
19+
20+
west config --local build.sysbuild False
21+
22+
Use the following command to configure west to use sysbuild by default:
1623

1724
.. parsed-literal::
1825
:class: highlight
@@ -21,7 +28,14 @@ You can do this either per-workspace, using the local configuration option, or f
2128
2229
.. group-tab:: Global sysbuild configuration
2330

24-
Use the following command to configure west to use sysbuild by default for building all projects in all workspaces:
31+
Use the following command to configure west not to use sysbuild by default for building all projects in all workspaces:
32+
33+
.. parsed-literal::
34+
:class: highlight
35+
36+
west config --global build.sysbuild False
37+
38+
Use the following command to configure west to use sysbuild by default:
2539

2640
.. parsed-literal::
2741
:class: highlight

doc/nrf/installation/install_ncs.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,11 @@ Depending on your preferred development environment, complete the following step
102102
#. In the extension's :guilabel:`Welcome View`, click on :guilabel:`Manage toolchains`.
103103
The list of actions appears in the |VSC|'s quick pick.
104104
#. Click :guilabel:`Install Toolchain`.
105-
The list of available toolchain versions appears in the |VSC|'s quick pick.
105+
The list of available stable toolchain versions appears in the |VSC|'s quick pick.
106106
#. Select the toolchain version to install.
107107
The toolchain version should match the |NCS| version you are going to work with.
108108
If you have received a custom URL for installing the toolchain, you can provide it using the :guilabel:`Change Toolchain Index` button in the quick pick's header (wrench icon).
109+
If you are working with a development tag, disable the filter in the quick pick's header to list all available toolchains.
109110
The toolchain installation starts in the background, as can be seen in the notification that appears.
110111

111112
When you install the toolchain for the first time, the installed version is automatically selected for your project.
@@ -207,7 +208,7 @@ For more information about the repository and development model, see the :ref:`d
207208
#. In the extension's :guilabel:`Welcome View`, click on :guilabel:`Manage SDKs`.
208209
The list of actions appears in the |VSC|'s quick pick.
209210
#. Click :guilabel:`Install SDK`.
210-
The list of available SDK versions appears in the |VSC|'s quick pick.
211+
The list of available stable SDK versions appears in the |VSC|'s quick pick.
211212
#. Select the SDK version to install.
212213
|install_latest_version|
213214

0 commit comments

Comments
 (0)