Skip to content

Commit 49c2635

Browse files
greg-ferrlubos
authored andcommitted
doc: update for VSC extension release
Updated documentation for the changes in the VSC extension NCS 3.0.0 release. VSC-2894. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent e60ece6 commit 49c2635

File tree

7 files changed

+30
-9
lines changed

7 files changed

+30
-9
lines changed

doc/nrf/app_dev/config_and_build/building.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Just as for creating the application, you can build the application using either
2020
For instructions, see `How to build an application`_ in the extension documentation.
2121

2222
By default, the extension runs both stages of the CMake build (:ref:`configuration phase and building phase <app_build_system>`).
23-
If you want to only set up the build configuration without building it, make sure the :guilabel:`Build after generating configuration` is not selected.
23+
If you want to only set up the build configuration without building the final binary, make sure the :guilabel:`Generate only` checkbox is selected.
2424

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.
25+
To build with :ref:`configuration_system_overview_sysbuild`, either :ref:`keep the default setting selected <sysbuild_enabled_ncs>` or select the :guilabel:`Use sysbuild` radio button.
2626

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

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

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ Sysbuild images
99

1010
:ref:`configuration_system_overview_sysbuild` allows you to add additional images to your builds.
1111

12-
1312
Enabling images
14-
===============
13+
***************
1514

1615
To add an additional image using sysbuild, you must modify the central sysbuild configuration.
1716
This is typically done in a `sysbuild.conf` file within an application, which is a Kconfig fragment applied to the default sysbuild configuration when a project is configured.
@@ -55,7 +54,7 @@ These options determine whether the secure boot image is included on the network
5554
.. _sysbuild_images_adding_custom_images:
5655

5756
Adding custom images
58-
====================
57+
********************
5958

6059
Custom images can be added directly to a project (or board) or to a Zephyr module, making them accessible to multiple projects.
6160

@@ -99,7 +98,7 @@ This method can be used to add a new image to the existing board target.
9998
.. _sysbuild_images_adding_custom_network_core_images:
10099

101100
Adding custom network core images
102-
---------------------------------
101+
=================================
103102

104103
To add an image for a different board target (like for the network core of the nRF5340 SoC), you must use a different syntax.
105104
This can be handled using the following approach:
@@ -162,7 +161,7 @@ This file is optional and is only needed if custom configuration needs to be set
162161
.. _sysbuild_images_adding_to_a_single_board:
163162

164163
Adding to a single board
165-
------------------------
164+
========================
166165

167166
You can place the same code as in the :ref:`sysbuild_images_adding_to_single_project` section, without the Zephyr sourcing, in a board directory.
168167
This enables the use of those images for any sysbuild-based project being built for that board:
@@ -193,7 +192,7 @@ sysbuild.cmake:
193192
.. _sysbuild_images_adding_via_a_zephyr_module:
194193

195194
Adding through a Zephyr module
196-
------------------------------
195+
==============================
197196

198197
To add images in a Zephyr module, create a folder within the module to hold the `Kconfig.sysbuild` and (optionally, if needed) `CMakeLists.txt` files.
199198
Then, add this folder to the Zephyr module file:
@@ -241,3 +240,11 @@ Kconfig.sysbuild:
241240
endif # !NETCORE_NONE
242241
243242
endmenu
243+
244+
.. _sysbuild_images_editing_in_nrfvsc:
245+
246+
Editing sysbuild images and domains in the |nRFVSC|
247+
***************************************************
248+
249+
The |nRFVSC| provides a GUI for editing sysbuild images and domains.
250+
See the `How to work with sysbuild domains`_ page in the extension documentation for more information.

doc/nrf/app_dev/create_application.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ Use the following steps depending on the application placement:
168168

169169
* :guilabel:`Create a blank application` - This will create an application with a code structure that you need to populate from scratch.
170170
* :guilabel:`Copy a sample` - This will create an application from an |NCS| sample or an |NCS| application.
171+
If you have more than one version of the |NCS| installed, you have to choose the version from which you copy the sample or the application from.
171172

172173
#. Enter the location and the name for the application.
173174
The location will be the *<west-workspace>/* directory mentioned in the :ref:`workspace application structure <create_application_types_workspace>`.

doc/nrf/includes/vsc_build_and_run_series.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
#. |exceptions_step|
1212
#. Open the nRF Connect extension in |VSC| by clicking its icon in the :guilabel:`Activity Bar`.
1313
#. In the extension's :guilabel:`Actions View`, click on :guilabel:`Flash`.
14+
If you have more than one device connected, you will be prompted to select the device to program.
15+
If the build system considers the build incomplete, using this action also triggers a rebuild before flashing.
1416

1517
For instructions about programming with the |nRFVSC|, see `How to flash an application`_.
1618

doc/nrf/installation/install_ncs.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,14 @@ For more information about the repository and development model, see the :ref:`d
207207
#. In the extension's :guilabel:`Welcome View`, click on :guilabel:`Manage SDKs`.
208208
The list of actions appears in the |VSC|'s quick pick.
209209
#. Click :guilabel:`Install SDK`.
210-
The list of available stable SDK versions appears in the |VSC|'s quick pick.
210+
The list of available stable SDK versions appears in the |VSC|'s quick pick, grouped into two categories:
211+
212+
* Pre-packaged SDKs - Bundled by Nordic Semiconductor.
213+
Available mostly for stable releases and some preview tags.
214+
Recommended for faster and more reliable download and installation.
215+
* GitHub - Taken from the `nRF Connect by Nordic Semiconductor GitHub organization <nrfconnect GitHub organization_>`_.
216+
Available for stable releases, but also preview tags and branches (after disabling the filter in the quick pick).
217+
211218
#. Select the SDK version to install.
212219
|install_latest_version|
213220

doc/nrf/installation/updating.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,9 @@ If you disabled automatic updates:
174174
#. The :guilabel:`Update` button appears when an update is available.
175175
Click the button to install the update.
176176

177+
Sometimes the extension can offer pre-release versions.
178+
In such cases, you can `switch to the pre-release version of the extension`_ to test the new features before they are released.
179+
177180
.. _west_update:
178181

179182
Updating west from command line

doc/nrf/links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -945,6 +945,7 @@
945945
.. _`Browse samples`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/reference/ui_sidebar_welcome.html#browse-samples
946946
.. _`nRF Terminal documentation`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/reference/ui_panel.html#nrf-connect-and-nrf-terminal-profiles
947947
.. _`switch to the pre-release version of the extension`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/rel_notes_overview.html#switching-to-a-pre-release-version
948+
.. _`How to work with sysbuild domains`: https://docs.nordicsemi.com/bundle/nrf-connect-vscode/page/guides/build_multi_domain.html
948949

949950
.. ### Source: files.nordicsemi.com
950951

0 commit comments

Comments
 (0)