From bec28e2888992f25b313279ecd1ebcb7f218e8b8 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc Date: Fri, 15 Aug 2025 15:13:02 +0200 Subject: [PATCH 1/2] doc: install_ncs: nRFVSC on Open VSX Registry Updated documentation with information about nRFVSC being available on the Open VSX Registry website. Edited how nRFVSC is referred to in the docs. VSC-3067. Signed-off-by: Grzegorz Ferenc --- applications/nrf5340_audio/doc/building.rst | 2 +- doc/nrf/app_dev/config_and_build/building.rst | 4 ++-- .../app_dev/config_and_build/cmake/index.rst | 6 +++--- .../config_and_build_system.rst | 6 +++--- .../hardware/add_new_led_example.rst | 4 ++-- .../config_and_build/hardware/index.rst | 2 +- .../hardware/use_gpio_pin_directly.rst | 2 +- .../config_and_build/kconfig/index.rst | 8 ++++---- .../sysbuild/sysbuild_images.rst | 6 +++--- doc/nrf/app_dev/create_application.rst | 16 ++++++++-------- .../custom/defining_custom_board.rst | 6 +++--- .../device_guides/fem/21540ek_dev_guide.rst | 2 +- .../device_guides/fem/2220ek_dev_guide.rst | 2 +- .../device_guides/nrf53/building_nrf53.rst | 2 +- .../device_guides/nrf54h/ug_nrf54h20_flpr.rst | 2 +- .../nrf54h/ug_nrf54h20_logging.rst | 2 +- .../device_guides/nrf54h/ug_nrf54h20_ppr.rst | 2 +- .../device_guides/nrf54l/building_nrf54l.rst | 4 ++-- .../nrf70/nrf7002eb2_dev_guide.rst | 2 +- .../nrf70/nrf7002eb_dev_guide.rst | 2 +- .../nrf70/nrf7002ek_dev_guide.rst | 2 +- .../device_guides/nrf91/nrf91_snippet.rst | 10 +++++----- .../thingy53/building_thingy53.rst | 2 +- .../thingy91_building_programming.rst | 2 +- doc/nrf/app_dev/programming.rst | 2 +- .../adding_code.rst | 4 ++-- .../managing_code.rst | 2 +- doc/nrf/external_comp/edge_impulse.rst | 2 +- doc/nrf/glossary.rst | 2 +- doc/nrf/includes/sample_fem_support.txt | 2 +- doc/nrf/includes/vsc_build_and_run.txt | 2 +- doc/nrf/includes/vsc_build_and_run_series.txt | 6 +++--- doc/nrf/installation/install_ncs.rst | 19 ++++++++++++------- doc/nrf/installation/recommended_versions.rst | 17 +++++++++++++++-- doc/nrf/installation/updating.rst | 10 +++++----- doc/nrf/links.txt | 2 ++ doc/nrf/shortcuts.txt | 9 +++++---- doc/nrf/test_and_optimize.rst | 6 +++--- doc/nrf/test_and_optimize/debugging.rst | 2 +- 39 files changed, 103 insertions(+), 82 deletions(-) diff --git a/applications/nrf5340_audio/doc/building.rst b/applications/nrf5340_audio/doc/building.rst index 857c36ffd6e2..3216c94f2741 100644 --- a/applications/nrf5340_audio/doc/building.rst +++ b/applications/nrf5340_audio/doc/building.rst @@ -16,7 +16,7 @@ You can build and program the applications in one of the following ways: * :ref:`nrf53_audio_app_building_standard` - Using this method requires building and programming each development kit separately. .. important:: - Building and programming using the |nRFVSC| is currently not supported. + Building and programming using |nRFVSC| is currently not supported. .. note:: You might want to check the :ref:`nRF5340 Audio application known issues ` before building and programming the applications. diff --git a/doc/nrf/app_dev/config_and_build/building.rst b/doc/nrf/app_dev/config_and_build/building.rst index d5bc0cbf399e..a735ee910875 100644 --- a/doc/nrf/app_dev/config_and_build/building.rst +++ b/doc/nrf/app_dev/config_and_build/building.rst @@ -10,13 +10,13 @@ Building an application |application_sample_definition| After you have :ref:`created an application `, you need to build it in order to be able to program it. -Just as for creating the application, you can build the application using either the |nRFVSC| or the command line. +Just as for creating the application, you can build the application using either |nRFVSC| or the command line. .. tabs:: .. group-tab:: nRF Connect for VS Code - To build with the |nRFVSC|, you first need to create a build configuration. + To build with |nRFVSC|, you first need to create a build configuration. For instructions, see `How to build an application`_ in the extension documentation. By default, the extension runs both stages of the CMake build (:ref:`configuration phase and building phase `). diff --git a/doc/nrf/app_dev/config_and_build/cmake/index.rst b/doc/nrf/app_dev/config_and_build/cmake/index.rst index 022b692f3ad5..275d058b017b 100644 --- a/doc/nrf/app_dev/config_and_build/cmake/index.rst +++ b/doc/nrf/app_dev/config_and_build/cmake/index.rst @@ -14,7 +14,7 @@ This file is the entry point of the build system as it specifies the application Maintaining CMakeLists.txt ************************** -The recommended method to maintain and update the :file:`CMakeLists.txt` file is to use the |nRFVSC|. +The recommended method to maintain and update the :file:`CMakeLists.txt` file is to use |nRFVSC|. The extension provides support for the `source control with west`_ and `CMake build system`_, including `build configuration management `_ and `source and config files overview
`_. .. _modifying_files_compiler: @@ -103,7 +103,7 @@ The following table lists the most common ones used in the |NCS|: | For applications that *do not* use multiple images, the static configuration can be selected with :makevar:`FILE_SUFFIX` (see above). - ``-DPM_STATIC_YML_FILE=pm_static_.yml`` -You can use these parameters in both the |nRFVSC| and the command line. +You can use these parameters in both |nRFVSC| and the command line. The build variables are applied one after another, based on the order you provide them. This is how you can specify them: @@ -148,7 +148,7 @@ Examples of commands .. group-tab:: nRF Connect for VS Code - To select the build type in the |nRFVSC|: + To select the build type in |nRFVSC|: 1. When `building an application `_ as described in the |nRFVSC| documentation, follow the steps for setting up the build configuration. #. In the **Add Build Configuration** screen, select the desired :file:`.conf` file from the :guilabel:`Configuration` drop-down menu. diff --git a/doc/nrf/app_dev/config_and_build/config_and_build_system.rst b/doc/nrf/app_dev/config_and_build/config_and_build_system.rst index 839eebaa32f7..6bd22dd40f15 100644 --- a/doc/nrf/app_dev/config_and_build/config_and_build_system.rst +++ b/doc/nrf/app_dev/config_and_build/config_and_build_system.rst @@ -33,12 +33,12 @@ The build and configuration system in Zephyr and the |NCS| uses the following bu - :file:`.dts`, :file:`.dtsi`, :file:`.overlay` - Hardware description language. - `Devicetree Visual Editor `_ - - Devicetree Visual Editor is part of the |nRFVSC|. You still need to be familiar with the devicetree language to use it. + - Devicetree Visual Editor is part of |nRFVSC|. You still need to be familiar with the devicetree language to use it. * - :ref:`Kconfig ` - :file:`Kconfig`, :file:`prj.conf`, :file:`.config` - Software configuration system also used in the Linux kernel. - `Kconfig GUI `_, :ref:`menuconfig and guiconfig ` - - | Kconfig GUI is part of the |nRFVSC|. + - | Kconfig GUI is part of |nRFVSC|. | The :ref:`Kconfig Reference ` provides the documentation for each configuration option. * - :ref:`partition_manager` - :file:`pm.yml`, :file:`pm_static.yml` @@ -103,7 +103,7 @@ The header file contains the same kind of information, but with defines usable b For more information, see :ref:`configuring_devicetree` and Zephyr's :ref:`zephyr:dt-guide`. In particular, :ref:`zephyr:set-devicetree-overlays` explains how the base devicetree files are selected. -In the |NCS|, you can use the |nRFVSC| to `create the devicetree files `_ and work with them using the dedicated `Devicetree Visual Editor `_. +In the |NCS|, you can use |nRFVSC| to `create the devicetree files `_ and work with them using the dedicated `Devicetree Visual Editor `_. You can also select the devicetree files when :ref:`cmake_options`. .. _configure_application_sw: diff --git a/doc/nrf/app_dev/config_and_build/hardware/add_new_led_example.rst b/doc/nrf/app_dev/config_and_build/hardware/add_new_led_example.rst index 769fa61ff0db..127cda935b83 100644 --- a/doc/nrf/app_dev/config_and_build/hardware/add_new_led_example.rst +++ b/doc/nrf/app_dev/config_and_build/hardware/add_new_led_example.rst @@ -9,7 +9,7 @@ Adding a dimmable LED node This example demonstrates how to add support for a dimmable LED node to your board in an overlay file. -To implement this example, you can either edit the devicetree files manually or use the |nRFVSC| with its `Devicetree language support`_ and the `Devicetree Visual Editor `_ (recommended). +To implement this example, you can either edit the devicetree files manually or use |nRFVSC| with its `Devicetree language support`_ and the `Devicetree Visual Editor `_ (recommended). For more advanced LED control, you can also use the :ref:`LEDs module ` of the :ref:`Common Application Framework (CAF) `, which provides additional features, such as LED effects and power management integration. @@ -33,7 +33,7 @@ Open or create the overlay file to edit Overlay files are a category of devicetree's :ref:`zephyr:devicetree-in-out-files`. These files can override node property values in multiple ways. -You can add them to your configuration :ref:`manually ` or by using the |nRFVSC| (see `How to create devicetree files`_). +You can add them to your configuration :ref:`manually ` or by using |nRFVSC| (see `How to create devicetree files`_). .. rst-class:: numbered-step diff --git a/doc/nrf/app_dev/config_and_build/hardware/index.rst b/doc/nrf/app_dev/config_and_build/hardware/index.rst index b6dc4b14f03d..9c6ff3c1b4cd 100644 --- a/doc/nrf/app_dev/config_and_build/hardware/index.rst +++ b/doc/nrf/app_dev/config_and_build/hardware/index.rst @@ -3,7 +3,7 @@ Configuring devicetree ###################### -The |nRFVSC| is the recommended tool for editing :ref:`configure_application_hw`. +|nRFVSC| is the recommended tool for editing :ref:`configure_application_hw`. The extension offers several layers of `Devicetree integration `_, ranging from summarizing devicetree settings in a menu and providing devicetree language support in the editor, to the Devicetree Visual Editor, a GUI tool for editing devicetree files. Follow the steps in `How to create devicetree files`_ and use one of the following options to edit the :file:`.dts`, :file:`.dtsi`, and :file:`.overlay` files: diff --git a/doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst b/doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst index 6ea91f34dc5f..325a8dd7a8d3 100644 --- a/doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst +++ b/doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst @@ -12,7 +12,7 @@ In the development phase of an embedded project, you can use this configuration You can use this solution to collect execution timings, or as a debugging tool. You can copy the following configuration snippets manually into the devicetree overlay files. -You can also use the `Devicetree Visual Editor `_ (either in GUI or text mode) in the |nRFVSC| to apply them. +You can also use the `Devicetree Visual Editor `_ (either in GUI or text mode) in |nRFVSC| to apply them. .. rst-class:: numbered-step diff --git a/doc/nrf/app_dev/config_and_build/kconfig/index.rst b/doc/nrf/app_dev/config_and_build/kconfig/index.rst index f5dec6f213fb..29b2e6e54796 100644 --- a/doc/nrf/app_dev/config_and_build/kconfig/index.rst +++ b/doc/nrf/app_dev/config_and_build/kconfig/index.rst @@ -22,7 +22,7 @@ The resulting configuration is written to the :file:`zephyr/.config` file in you This means that this file is available when building the application until you clean the build directory pristinely. .. note:: - While it is possible to edit the :file:`.config` file directly, you should use the nRF Kconfig GUI in the |nRFVSC| or a tool like menuconfig or guiconfig to update it. + While it is possible to edit the :file:`.config` file directly, you should use the nRF Kconfig GUI in |nRFVSC| or a tool like menuconfig or guiconfig to update it. These tools present all available options and allow you to select the ones that you need. They also show the dependencies between the options and their limitations. @@ -30,13 +30,13 @@ This means that this file is available when building the application until you c .. group-tab:: nRF Connect for VS Code - Use the nRF Kconfig GUI in the |nRFVSC| to select the desired options. + Use the nRF Kconfig GUI in |nRFVSC| to select the desired options. The GUI organizes the Kconfig options in a hierarchical list and lets you view and manage your selection. To locate a specific configuration option, use the **Search modules** field. Read the `Configuring with nRF Kconfig`_ page in the |nRFVSC| documentation for more information. - Alternatively, you can configure your application in the |nRFVSC| using menuconfig. + Alternatively, you can configure your application in |nRFVSC| using menuconfig. Open the **More actions..** menu next to `Kconfig action in the Actions View`_ to start menuconfig in the extension. .. group-tab:: Command line @@ -88,7 +88,7 @@ See :ref:`zephyr:setting_configuration_values` in the Zephyr documentation for i .. group-tab:: nRF Connect for VS Code - If you work with the |nRFVSC|, you can use one of the following options: + If you work with |nRFVSC|, you can use one of the following options: * Edit the :file:`prj.conf` directly in |VSC|. * Select an extra Kconfig fragment file when you `build an application `_. diff --git a/doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst b/doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst index 0b1479c77bbd..6cc22f2c2fec 100644 --- a/doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst +++ b/doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst @@ -311,8 +311,8 @@ Kconfig.sysbuild: .. _sysbuild_images_editing_in_nrfvsc: -Editing sysbuild images and domains in the |nRFVSC| -*************************************************** +Editing sysbuild images and domains in |nRFVSC| +*********************************************** -The |nRFVSC| provides a GUI for editing sysbuild images and domains. +|nRFVSC| provides a GUI for editing sysbuild images and domains. See the `How to work with sysbuild domains`_ page in the extension documentation for more information. diff --git a/doc/nrf/app_dev/create_application.rst b/doc/nrf/app_dev/create_application.rst index 877ad3cabc9c..44cbb0e3c51b 100644 --- a/doc/nrf/app_dev/create_application.rst +++ b/doc/nrf/app_dev/create_application.rst @@ -138,7 +138,7 @@ Creating an |NCS| application ***************************** The process for creating an |NCS| application depends on the development environment. -Using the |nRFVSC| is the recommended method. +Using |nRFVSC| is the recommended method. .. note:: No steps are provided for the creation of :ref:`repository applications `. @@ -146,8 +146,8 @@ Using the |nRFVSC| is the recommended method. .. _creating_vsc: -Creating application in the |nRFVSC| -==================================== +Creating application in |nRFVSC| +================================ .. note:: If you prefer, you can `start VS Code walkthrough`_ and create applications and build configurations from there. @@ -158,10 +158,10 @@ Use the following steps depending on the application placement: .. group-tab:: Workspace application (recommended) - To create a workspace application in the |nRFVSC|: + To create a workspace application in |nRFVSC|: 1. Open |VSC|. - #. Open the |nRFVSC|. + #. Open |nRFVSC|. #. In the :guilabel:`Welcome View`, click the :guilabel:`Create a new application` action. A quick pick menu appears. #. Choose one of the following options: @@ -194,10 +194,10 @@ Use the following steps depending on the application placement: .. group-tab:: Freestanding application - To create a freestanding application in the |nRFVSC|: + To create a freestanding application in |nRFVSC|: 1. Open |VSC|. - #. Open the |nRFVSC|. + #. Open |nRFVSC|. #. In the :guilabel:`Welcome View`, click the :guilabel:`Create a new application` action. A quick pick menu appears. #. Choose one of the following options: @@ -311,7 +311,7 @@ To create an application from the add-on index, complete the following steps: .. tab:: nRF Connect for VS Code (recommended) - Complete the following steps in the |nRFVSC|: + Complete the following steps in |nRFVSC|: 1. In the :guilabel:`Welcome View`, click :guilabel:`Create a new application`. #. Select :guilabel:`Browse nRF Connect SDK Add-on Index`. diff --git a/doc/nrf/app_dev/device_guides/custom/defining_custom_board.rst b/doc/nrf/app_dev/device_guides/custom/defining_custom_board.rst index 748fc591a56f..0fb69dc82c61 100644 --- a/doc/nrf/app_dev/device_guides/custom/defining_custom_board.rst +++ b/doc/nrf/app_dev/device_guides/custom/defining_custom_board.rst @@ -13,7 +13,7 @@ This page lists resources about defining custom board files in the |NCS|. To read about how to program a custom board, see :ref:`programming_custom_board`. .. note:: - If you want to go through a dedicated training related to some of the topics covered here, enroll in the `nRF Connect SDK Intermediate course`_ in the `Nordic Developer Academy`_. The `Lesson 3 - Adding custom board support`_ shows how to add custom board support using the |nRFVSC|. + If you want to go through a dedicated training related to some of the topics covered here, enroll in the `nRF Connect SDK Intermediate course`_ in the `Nordic Developer Academy`_. The `Lesson 3 - Adding custom board support`_ shows how to add custom board support using |nRFVSC|. Guidelines for custom boards **************************** @@ -23,8 +23,8 @@ To define your own board, you can use the following Zephyr guides as reference, * :ref:`custom_board_definition` is a guide to adding your own custom board to the Zephyr build system. * :ref:`board_porting_guide` is a complete guide to porting Zephyr to your own board. -Adding a custom board in the |nRFVSC| -************************************* +Adding a custom board in |nRFVSC| +********************************* |nRFVSC| lets you add your own boards to your |NCS| project. Read the `How to work with boards and devices`_ page in the extension documentation for detailed steps. diff --git a/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst b/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst index 0f378962ad3b..812ec0eefd54 100644 --- a/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst +++ b/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst @@ -33,7 +33,7 @@ For example, if you build for nRF52840 DK on the command line, you can use the f west build -b nrf52840dk/nrf52840 -- -DSHIELD=nrf21540ek -If you use the |nRFVSC|, specify ``-DSHIELD=nrf21540ek`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. +If you use |nRFVSC|, specify ``-DSHIELD=nrf21540ek`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. Alternatively, add the shield in the project's :file:`CMakeLists.txt` file: diff --git a/doc/nrf/app_dev/device_guides/fem/2220ek_dev_guide.rst b/doc/nrf/app_dev/device_guides/fem/2220ek_dev_guide.rst index d22acf416986..932b4ba98182 100644 --- a/doc/nrf/app_dev/device_guides/fem/2220ek_dev_guide.rst +++ b/doc/nrf/app_dev/device_guides/fem/2220ek_dev_guide.rst @@ -42,7 +42,7 @@ For example, if you build for nRF52840 DK on the command line, you can use the f west build -b nrf52840dk/nrf52840 -- -DSHIELD=nrf2220ek -If you use the |nRFVSC|, specify ``-DSHIELD=nrf2220ek`` in the *Extra Cmake arguments* field when `setting up a build configuration `_. +If you use |nRFVSC|, specify ``-DSHIELD=nrf2220ek`` in the *Extra Cmake arguments* field when `setting up a build configuration `_. Alternatively, add the shield in the project's :file:`CMakeLists.txt` file: diff --git a/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst b/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst index fba421088074..b0a385d2e78c 100644 --- a/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst +++ b/doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst @@ -19,7 +19,7 @@ The steps differ depending on whether you work with |VSC| or on the command line Using |VSC| =========== -You can build and program separate images or combined images using the |nRFVSC|. +You can build and program separate images or combined images using |nRFVSC|. .. tabs:: diff --git a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_flpr.rst b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_flpr.rst index cf8564087bd5..fc5d2eea6a4b 100644 --- a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_flpr.rst +++ b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_flpr.rst @@ -127,7 +127,7 @@ To complete the build, do the following: Separate images --------------- -You can build and program the application sample and the FLPR sample as separate images using either the |nRFVSC| or the command line. +You can build and program the application sample and the FLPR sample as separate images using either |nRFVSC| or the command line. To use nRF Util, see `nRF Util`_. Depending on the method you select, complete the following steps: diff --git a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_logging.rst b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_logging.rst index a64a38a9e6ef..a61510b201e4 100644 --- a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_logging.rst +++ b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_logging.rst @@ -84,7 +84,7 @@ Reading the logs To read the STM log output on the UART, consult the following documentation pages: -* If you want to use the *nRF Serial Terminal* from the |nRFVSC|, see the `nRF Terminal documentation`_ on the `nRF Connect for Visual Studio Code`_ documentation site. +* If you want to use the *nRF Serial Terminal* from |nRFVSC|, see the `nRF Terminal documentation`_ on the `nRF Connect for Visual Studio Code`_ documentation site. * If you want to use PuTTY, see :ref:`putty`. .. note:: diff --git a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ppr.rst b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ppr.rst index 60db73ea9e18..d7e7a565f8ad 100644 --- a/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ppr.rst +++ b/doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ppr.rst @@ -106,7 +106,7 @@ To complete the build, do the following: Separate images --------------- -You can build and program the application sample and the PPR sample as separate images using either the |nRFVSC| or the command line. +You can build and program the application sample and the PPR sample as separate images using either |nRFVSC| or the command line. Refer to `nRF Util`_ documentation for instructions on using nRF Util. Depending on the method you select, complete the following steps: diff --git a/doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst b/doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst index e93b1859cf09..283fd113392a 100644 --- a/doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst +++ b/doc/nrf/app_dev/device_guides/nrf54l/building_nrf54l.rst @@ -82,7 +82,7 @@ Complete the following steps: Separate images --------------- -You can build and program application sample and the FLPR sample as separate images using the |nRFVSC| or command line. +You can build and program application sample and the FLPR sample as separate images using |nRFVSC| or command line. To use nRF Util, see `Programming application firmware on the nRF54L15 SoC`_. Depending on the selected method, complete the following steps: @@ -92,7 +92,7 @@ Depending on the selected method, complete the following steps: .. note:: - The |nRFVSC| currently offers experimental support for the nRF54L15's FLPR core. + |nRFVSC| currently offers experimental support for the nRF54L15's FLPR core. Certain features, particularly debugging, may not function as expected. .. include:: /includes/vsc_build_and_run.txt diff --git a/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb2_dev_guide.rst b/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb2_dev_guide.rst index 900a072f079c..7b9a8cb9ff17 100644 --- a/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb2_dev_guide.rst +++ b/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb2_dev_guide.rst @@ -98,7 +98,7 @@ For example, if you build the :ref:`wifi_shell_sample` sample for nRF54L15 DK on west build -p -b nrf54l15dk/nrf54l15/cpuapp -- -Dshell_SHIELD="nrf7002eb2" -Dshell_SNIPPET=nrf70-wifi -If you use the |nRFVSC|, specify ``-DSHIELD=nrf7002eb2`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. +If you use |nRFVSC|, specify ``-DSHIELD=nrf7002eb2`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. Alternatively, add the shield in the project's :file:`CMakeLists.txt` file by using the following command: diff --git a/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb_dev_guide.rst b/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb_dev_guide.rst index 625a51c28876..45948265a4c1 100644 --- a/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb_dev_guide.rst +++ b/doc/nrf/app_dev/device_guides/nrf70/nrf7002eb_dev_guide.rst @@ -113,7 +113,7 @@ For example, if you build for Thingy:53 on the command line, you can use the fol west build -b thingy53/nrf5340/cpuapp -- -DSHIELD=nrf7002eb -If you use the |nRFVSC|, specify ``-DSHIELD=nrf7002eb`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. +If you use |nRFVSC|, specify ``-DSHIELD=nrf7002eb`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. Alternatively, add the shield in the project's :file:`CMakeLists.txt` file by using the following command: diff --git a/doc/nrf/app_dev/device_guides/nrf70/nrf7002ek_dev_guide.rst b/doc/nrf/app_dev/device_guides/nrf70/nrf7002ek_dev_guide.rst index a094b3c64ad2..1c0b0768a235 100644 --- a/doc/nrf/app_dev/device_guides/nrf70/nrf7002ek_dev_guide.rst +++ b/doc/nrf/app_dev/device_guides/nrf70/nrf7002ek_dev_guide.rst @@ -49,7 +49,7 @@ For example, if you build for nRF5340 DK on the command line, you can use the fo west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf7002ek -If you use the |nRFVSC|, specify ``-DSHIELD=nrf7002ek`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. +If you use |nRFVSC|, specify ``-DSHIELD=nrf7002ek`` in the **Extra Cmake arguments** field when `setting up a build configuration `_. Alternatively, add the shield in the project's :file:`CMakeLists.txt` file, specifying the below settings, depending on which IC is to be used: diff --git a/doc/nrf/app_dev/device_guides/nrf91/nrf91_snippet.rst b/doc/nrf/app_dev/device_guides/nrf91/nrf91_snippet.rst index 7cef79420188..7ee44dcbb522 100644 --- a/doc/nrf/app_dev/device_guides/nrf91/nrf91_snippet.rst +++ b/doc/nrf/app_dev/device_guides/nrf91/nrf91_snippet.rst @@ -62,7 +62,7 @@ You can do this in one of the following ways: -D_SNIPPET="nrf91-modem-trace-ext-flash" [...] - To build with the |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-ext-flash" [...]`` in the **Extra CMake arguments** field. + To build with |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-ext-flash" [...]`` in the **Extra CMake arguments** field. See :ref:`cmake_options` for more details. @@ -96,7 +96,7 @@ You can do this in one of the following ways: -D_SNIPPET="nrf91-modem-trace-ram" [...] - To build with the |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-ram" [...]`` in the **Extra CMake arguments** field. + To build with |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-ram" [...]`` in the **Extra CMake arguments** field. See :ref:`cmake_options` for more details. @@ -138,7 +138,7 @@ You can do this in one of the following ways: -D_SNIPPET="nrf91-modem-trace-uart" [...] - To build with the |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-uart" [...]`` in the **Extra CMake arguments** field. + To build with |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-uart" [...]`` in the **Extra CMake arguments** field. See :ref:`cmake_options` for more details. @@ -171,7 +171,7 @@ You can do this in one of the following ways: -D_SNIPPET="nrf91-modem-trace-rtt" [...] - To build with the |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-rtt" [...]`` in the **Extra CMake arguments** field. + To build with |nRFVSC|, specify ``-D_SNIPPET="nrf91-modem-trace-rtt" [...]`` in the **Extra CMake arguments** field. See :ref:`cmake_options` for more details. @@ -204,6 +204,6 @@ You can do this in one of the following ways: -D_SNIPPET="tfm-enable-share-uart" [...] - To build with the |nRFVSC|, specify ``-D_SNIPPET="tfm-enable-share-uart" [...]`` in the **Extra CMake arguments** field. + To build with |nRFVSC|, specify ``-D_SNIPPET="tfm-enable-share-uart" [...]`` in the **Extra CMake arguments** field. See :ref:`cmake_options` for more details. diff --git a/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst b/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst index 69c677ba457f..d08927312779 100644 --- a/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst +++ b/doc/nrf/app_dev/device_guides/thingy53/building_thingy53.rst @@ -115,7 +115,7 @@ You can program the precompiled firmware image in one of the following ways: Building and programming using |VSC| ************************************ -Complete the following steps to build and program using the |nRFVSC|: +Complete the following steps to build and program using |nRFVSC|: .. |sample_path_vsc| replace:: :file:`nrf/samples/bluetooth/peripheral_lbs` diff --git a/doc/nrf/app_dev/device_guides/thingy91/thingy91_building_programming.rst b/doc/nrf/app_dev/device_guides/thingy91/thingy91_building_programming.rst index 6164695f3960..e174fcb8727d 100644 --- a/doc/nrf/app_dev/device_guides/thingy91/thingy91_building_programming.rst +++ b/doc/nrf/app_dev/device_guides/thingy91/thingy91_building_programming.rst @@ -81,7 +81,7 @@ Complete the following steps to program firmware onto Thingy:91: .. group-tab:: nRF Connect for VS Code - 5. In the |nRFVSC|, click the :guilabel:`Flash` option in the **Actions View**. + 5. In |nRFVSC|, click the :guilabel:`Flash` option in the **Actions View**. If you have multiple boards connected, you are prompted to pick a device at the top of the screen. diff --git a/doc/nrf/app_dev/programming.rst b/doc/nrf/app_dev/programming.rst index a824f29fcdfc..941e80d122b5 100644 --- a/doc/nrf/app_dev/programming.rst +++ b/doc/nrf/app_dev/programming.rst @@ -18,7 +18,7 @@ To program the :ref:`output build files ` to your device .. include:: ../includes/vsc_build_and_run_series.txt -The flash command programs all cores by default, both in the |nRFVSC| and on the command line. +The flash command programs all cores by default, both in |nRFVSC| and on the command line. If you want to program only one selected core, use ``west flash`` on the command line and :ref:`specify the domain `. .. _programming_selecting_runner: diff --git a/doc/nrf/dev_model_and_contributions/adding_code.rst b/doc/nrf/dev_model_and_contributions/adding_code.rst index 9c7cb5766880..d0d6f8454e89 100644 --- a/doc/nrf/dev_model_and_contributions/adding_code.rst +++ b/doc/nrf/dev_model_and_contributions/adding_code.rst @@ -40,7 +40,7 @@ In such case, you must obtain a copy of the |NCS| on your file system and then m To obtain a copy of the |NCS|, you can use one of the following methods: -* :ref:`Install the nRF Connect SDK ` using the |nRFVSC| and download the desired |NCS| version. +* :ref:`Install the nRF Connect SDK ` using |nRFVSC| and download the desired |NCS| version. This corresponds to steps 2 and 3 on the linked page. * Follow the instructions in the :ref:`dm-wf-get-ncs` section of the documentation. This requires you to install Git and west, but you can then ignore them from that point onwards. @@ -59,7 +59,7 @@ Workflow 2: Freestanding application repository Another approach to maintaining your application is to completely decouple it from the |NCS| repositories and instead host it wherever you prefer - in Git, another version control system, or simply on your hard drive. This is typically also known as a :ref:`freestanding ` or "out-of-tree" application, meaning that the application, board definitions, and any other libraries are actually outside any of the repositories provided by the |NCS| and can be placed anywhere at all. -As long as you do not need to make changes to any of the repositories of the |NCS|, you can use either the |nRFVSC| or command line to get the source code and update it later, as described in :ref:`install_ncs`. +As long as you do not need to make changes to any of the repositories of the |NCS|, you can use either |nRFVSC| or command line to get the source code and update it later, as described in :ref:`install_ncs`. This allows you to manage your application separately, whether it is inside or outside the top folder of the |NCS|. If you choose to have your application outside of the folder hierarchy of the |NCS|, the build system will find the location of the SDK through the :makevar:`ZEPHYR_BASE` environment variable, which is set either through a script or manually in an IDE. More information about application development and the |NCS| build and configuration system can be found in the :ref:`app_build_system` documentation section. diff --git a/doc/nrf/dev_model_and_contributions/managing_code.rst b/doc/nrf/dev_model_and_contributions/managing_code.rst index f6eb8129ea8b..a770f3cb1d2b 100644 --- a/doc/nrf/dev_model_and_contributions/managing_code.rst +++ b/doc/nrf/dev_model_and_contributions/managing_code.rst @@ -37,7 +37,7 @@ This can be ``main`` if you want the latest state, or any released version (for If you omit the ``--mr`` parameter, west defaults to ``main``. This is the procedure used for :ref:`getting the nRF Connect SDK code ` when :ref:`install_ncs` using the command line. -When you install the |NCS| using the |nRFVSC|, this is handled by the extension. +When you install the |NCS| using |nRFVSC|, this is handled by the extension. .. _dm-wf-update-ncs: diff --git a/doc/nrf/external_comp/edge_impulse.rst b/doc/nrf/external_comp/edge_impulse.rst index 6b97e5354cca..cb234b45c8b0 100644 --- a/doc/nrf/external_comp/edge_impulse.rst +++ b/doc/nrf/external_comp/edge_impulse.rst @@ -108,7 +108,7 @@ Complete the following steps to configure the building process: The API key is provided using a format in which *key_name* is followed by *key_value*. For example, if the URI uses ``x-api_key`` for authentication, the :c:macro:`EI_API_KEY_HEADER` can be defined as follows: ``x-api-key:aaaabbbbccccdddd``. The ``aaaabbbbccccdddd`` is a sample *key_value*. - See :ref:`cmake_options` for more information about defining CMake options for command line builds and the |nRFVSC|. + See :ref:`cmake_options` for more information about defining CMake options for command line builds and |nRFVSC|. See `Downloading model directly from Edge Impulse studio`_ for details about downloading model directly from the Edge Impulse studio. Downloading model directly from Edge Impulse studio diff --git a/doc/nrf/glossary.rst b/doc/nrf/glossary.rst index f70a622471f9..1b72d47fd192 100644 --- a/doc/nrf/glossary.rst +++ b/doc/nrf/glossary.rst @@ -620,7 +620,7 @@ Glossary nRF Connect SDK Add-ons An index of publicly available supplementary components that extend the |NCS|'s functionality. - The index can be accessed from the |nRFVSC|, and can also be browsed on `add-on webpage `_. + The index can be accessed from |nRFVSC|, and can also be browsed on `add-on webpage `_. Add-ons in the index follow specific contribution guidelines and are maintained by their respective owners. The workspace applications listed there can be used to create out-of-tree :ref:`workspace applications `. For more information, including how to contribute your own add-on to the index, read :file:`README.md` and :file:`CONTRIBUTING.md` in the `ncs-app-index repository `_. diff --git a/doc/nrf/includes/sample_fem_support.txt b/doc/nrf/includes/sample_fem_support.txt index 37ec5eedee1b..2cfce4549495 100644 --- a/doc/nrf/includes/sample_fem_support.txt +++ b/doc/nrf/includes/sample_fem_support.txt @@ -11,7 +11,7 @@ You can add support for the nRF21540 front-end module to this sample by using on .. group-tab:: nRF Connect for VS Code - To build the sample in the |nRFVSC| for an nRF52840 DK with the nRF21540 EK attached, add the shield variable in the build configuration's :guilabel:`Extra CMake arguments` and rebuild the build configuration. + To build the sample in |nRFVSC| for an nRF52840 DK with the nRF21540 EK attached, add the shield variable in the build configuration's :guilabel:`Extra CMake arguments` and rebuild the build configuration. For example: ``-DSHIELD=nrf21540ek``. See `How to work with build configurations`_ in the |nRFVSC| documentation for more information. diff --git a/doc/nrf/includes/vsc_build_and_run.txt b/doc/nrf/includes/vsc_build_and_run.txt index e7dae870b4a5..1ad5fda51aa9 100644 --- a/doc/nrf/includes/vsc_build_and_run.txt +++ b/doc/nrf/includes/vsc_build_and_run.txt @@ -1,2 +1,2 @@ -1. Open the |nRFVSC|. +1. Open |nRFVSC|. #. Complete the steps listed on the `How to build an application`_ page in the |nRFVSC| documentation. diff --git a/doc/nrf/includes/vsc_build_and_run_series.txt b/doc/nrf/includes/vsc_build_and_run_series.txt index 15e47c07cd34..531122170325 100644 --- a/doc/nrf/includes/vsc_build_and_run_series.txt +++ b/doc/nrf/includes/vsc_build_and_run_series.txt @@ -2,7 +2,7 @@ .. group-tab:: nRF Connect for VS Code - Before you program a device in the |nRFVSC|, you need to set up a build configuration, which is part of :ref:`building`. + Before you program a device in |nRFVSC|, you need to set up a build configuration, which is part of :ref:`building`. Complete the following steps to program the application: @@ -14,11 +14,11 @@ If you have more than one device connected, you will be prompted to select the device to program. If the build system considers the build incomplete, using this action also triggers a rebuild before flashing. - For instructions about programming with the |nRFVSC|, see `How to flash an application`_. + For instructions about programming with |nRFVSC|, see `How to flash an application`_. If you want to program with custom options or scripts, read about `Binding custom tasks to actions`_ in the extension documentation. - For information about how to flash and erase in the |nRFVSC|, read about the `Application-specific flash options`_. + For information about how to flash and erase in |nRFVSC|, read about the `Application-specific flash options`_. .. group-tab:: Command line diff --git a/doc/nrf/installation/install_ncs.rst b/doc/nrf/installation/install_ncs.rst index 6bfdf70da8d8..a2c510c9aa4f 100644 --- a/doc/nrf/installation/install_ncs.rst +++ b/doc/nrf/installation/install_ncs.rst @@ -18,7 +18,7 @@ Regardless of which way you choose, the following steps install the |NCS| source This includes everything that is required by Zephyr's :ref:`zephyr:getting_started` together with additional tools and Python dependencies that the |NCS| uses. .. note:: - Using |VSC| and the |nRFVSC| is also covered in the `Installing nRF Connect SDK and VS Code`_ exercise of the `nRF Connect SDK Fundamentals course`_ on Nordic Developer Academy. + Using |VSC| and |nRFVSC| is also covered in the `Installing nRF Connect SDK and VS Code`_ exercise of the `nRF Connect SDK Fundamentals course`_ on Nordic Developer Academy. .. rst-class:: numbered-step @@ -44,7 +44,7 @@ Depending on your preferred development environment, install the following softw .. tabs:: - .. group-tab:: nRF Connect for Visual Studio Code + .. group-tab:: nRF Connect for VS Code .. include:: /includes/install_sdk_common_prerequisites.txt @@ -52,7 +52,12 @@ Depending on your preferred development environment, install the following softw * The latest version of |VSC| for your operating system from the `Visual Studio Code download page`_ or `using this direct link `_. * In |VSC|, the latest version of the `nRF Connect for VS Code Extension Pack`_. - The |nRFVSC| comes with its own bundled version of some of the nRF Util commands. + |nRFVSC| comes with its own bundled version of some of the nRF Util commands. + + .. note:: + You can also use a different IDE compatible with the VSIX format and install the extensions that are part of the nRF Connect for VS Code Extension Pack from the `Open VSX Registry`_. + However, Nordic Semiconductor does not test editors other than |VSC| for compatibility with |nRFVSC|. + While you are encouraged to report any issues you encounter on `DevZone`_, issues discovered in editors other than |VSC| and not reproducible in |VSC| will not be prioritized. .. group-tab:: Command line @@ -88,7 +93,7 @@ Depending on your preferred development environment, complete the following step .. tabs:: - .. group-tab:: nRF Connect for Visual Studio Code + .. group-tab:: nRF Connect for VS Code .. note:: If you prefer, you can now `start VS Code walkthrough`_ and install the toolchain and the SDK from there. @@ -219,7 +224,7 @@ For more information about the repository and development model, see the :ref:`d .. tabs:: - .. group-tab:: nRF Connect for Visual Studio Code + .. group-tab:: nRF Connect for VS Code To clone the |NCS| code, complete the following steps: @@ -466,7 +471,7 @@ Define the required environment variables as follows, depending on your operatin Alternative method: System-wide installation ******************************************** -System-wide installation is an alternative to the recommended installation methods using the |nRFVSC| or nRF Util. +System-wide installation is an alternative to the recommended installation methods using |nRFVSC| or nRF Util. It gives you more control over each of the required tools, but requires more familiarity with Zephyr and with each of the tools. To install the |NCS| system-wide, complete the following steps: @@ -674,7 +679,7 @@ To install the |NCS| system-wide, complete the following steps: #. Follow the steps in the "Install the Zephyr SDK" section in Zephyr's :ref:`zephyr:getting_started` to install the Zephyr SDK. #. Depending on your preferred development environment: - * If you want to work with |VSC|, install the |nRFVSC| (the default IDE for the |NCS|). + * If you want to work with |VSC|, install |nRFVSC| (the default IDE for the |NCS|). * If you want to work from command line, :ref:`build_environment_cli`. #. If you want to build `Matter`_ applications, additionally install the `GN`_ meta-build system. diff --git a/doc/nrf/installation/recommended_versions.rst b/doc/nrf/installation/recommended_versions.rst index 64a16fc2841a..dbd5fc99cb8b 100644 --- a/doc/nrf/installation/recommended_versions.rst +++ b/doc/nrf/installation/recommended_versions.rst @@ -388,15 +388,28 @@ nRF Connect for Visual Studio Code |vsc_extension_description| -In addition, the |nRFVSC| provides the following configuration tools for the :ref:`build system components `: +In addition, |nRFVSC| provides the following configuration tools for the :ref:`build system components `: * For CMake, the `build configuration management `_. * For Devicetree, the `Devicetree Visual Editor `_. * For Kconfig, the `Kconfig GUI `_. +* For Zephyr's :ref:`zephyr:optimization_tools`, the interactive `Memory report`_ feature. -The extension follows its own `release cycle `_. +The extensions that make up |nRFVSC| are nRF Connect for VS Code, nRF Kconfig, nRF DeviceTree, and nRF Terminal. +While you can install each extension separately, some of them will not work without others and you need all four to use all of the features. + +The extensions follow their own `release cycle `_. Use the latest available release for development. +The extensions are available for download from the following websites: + +* |VSC| Marketplace, where the extensions are bundled as the `nRF Connect for VS Code Extension Pack`_. +* `Open VSX Registry`_, from where you can install the extensions separately to editors based on |VSC| and compatible with the VSIX format. + + .. note:: + Nordic Semiconductor does not test editors other than |VSC| for compatibility with |nRFVSC|. + While you are encouraged to report any issues you encounter on `DevZone`_, issues discovered in editors other than |VSC| and not reproducible in |VSC| will not be prioritized. + See the :ref:`install_ncs` page for information about how to use the extension to manage |NCS| toolchain installations. For more information about the extension and what it offers, visit the `nRF Connect for Visual Studio Code`_ documentation. diff --git a/doc/nrf/installation/updating.rst b/doc/nrf/installation/updating.rst index 1e1b55de311e..479001e43080 100644 --- a/doc/nrf/installation/updating.rst +++ b/doc/nrf/installation/updating.rst @@ -32,7 +32,7 @@ Depending on your preferred development method, you can start the correct CLI to .. tabs:: - .. group-tab:: nRF Connect for Visual Studio Code + .. group-tab:: nRF Connect for VS Code Start the nRF Connect terminal profile from the :guilabel:`Panel View`. See `the extension documentation `_ for more information. @@ -88,10 +88,10 @@ Use the method corresponding to the way you installed the |NCS|, as described in .. group-tab:: nRF Connect for VS Code - The |nRFVSC| lets you update the associated |NCS| repositories within the :guilabel:`Source Control View`. + |nRFVSC| lets you update the associated |NCS| repositories within the :guilabel:`Source Control View`. For detailed instructions, see the `west module management`_ page in the extension's documentation. - You can also change the SDK or toolchain in the |nRFVSC| to a new one. + You can also change the SDK or toolchain in |nRFVSC| to a new one. Complete the steps listed on the `How to change SDK and toolchain versions`_ page in the extension's documentation. .. group-tab:: Command line @@ -161,8 +161,8 @@ After you updated the |NCS| repositories to the new version and you need to migr .. _vsc_update: -Updating the |nRFVSC| -********************* +Updating |nRFVSC| +***************** |VSC| checks for extension updates and automatically installs them when they are available. After an extension is updated, |VSC| prompts you to reload the application. diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 7a40ecbdff22..045aa846d473 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -1692,6 +1692,8 @@ .. ### Source: other (2 links or less from the same URL) +.. _`Open VSX Registry`: https://open-vsx.org/ + .. _`Amazon Root CA 1`: https://www.amazontrust.com/repository/AmazonRootCA1.pem .. _`Memfault Diagnostic GATT Service`: https://memfault.notion.site/Memfault-Diagnostic-GATT-Service-MDS-ffd5a430062649cd9bf6edbf64e2563b diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt index a9fce256ece7..ed9b66d5ad18 100644 --- a/doc/nrf/shortcuts.txt +++ b/doc/nrf/shortcuts.txt @@ -87,10 +87,10 @@ .. ### VSC shortcuts -.. |vsc_extension_description| replace:: The |nRFVSC| is a complete IDE for developing applications compatible with the |NCS|. - The extension includes an interface for managing SDK and toolchain installations, an interface to the compiler and linker, an RTOS-aware debugger, a seamless interface to the |NCS|, and a serial terminal. +.. |vsc_extension_description| replace:: |nRFVSC| is a set of VSIX extensions that turns |VSC| into a complete IDE for developing applications compatible with the |NCS|. + The extensions that are part of |nRFVSC| provide an interface for managing SDK and toolchain installations, an interface to the compiler and linker, an RTOS-aware debugger, a seamless interface to the |NCS|, and a serial terminal. .. |VSC| replace:: Visual Studio Code -.. |nRFVSC| replace:: nRF Connect for VS Code extension +.. |nRFVSC| replace:: nRF Connect for VS Code .. ### Deprecation shortcuts @@ -182,7 +182,8 @@ .. ### Other shortcuts .. |ncs_oot_sample_note| replace:: Some samples in the |NCS| are currently not designed to work out-of-tree. - You may need to manually configure your sample to work correctly in the |nRFVSC|. + You may need to manually configure your sample to work correctly in |nRFVSC|. + .. |ncs_repo| replace:: https://github.com/nrfconnect/sdk-nrf .. |ncs_nrfxlib_repo| replace:: https://github.com/nrfconnect/sdk-nrfxlib diff --git a/doc/nrf/test_and_optimize.rst b/doc/nrf/test_and_optimize.rst index bbdf6fe86a0b..18407b59a90a 100644 --- a/doc/nrf/test_and_optimize.rst +++ b/doc/nrf/test_and_optimize.rst @@ -69,9 +69,9 @@ Use one of the following methods: For more information about how to connect using the app, see the `steps in the Serial Terminal documentation `_. - .. group-tab:: nRF Connect for Visual Studio Code + .. group-tab:: nRF Connect for VS Code - The |nRFVSC| includes an integrated serial port and RTT terminal, which you can use to connect to your board. + |nRFVSC| includes an integrated serial port and RTT terminal, which you can use to connect to your board. For detailed instructions, see `How to connect to the terminal`_ on the `nRF Connect for Visual Studio Code`_ documentation site. The extension is available for Windows, Linux, and macOS. @@ -116,7 +116,7 @@ Use one of the following methods: .. group-tab:: J-Link RTT Viewer .. note:: - You can connect using RTT also from the |nRFVSC|. + You can connect using RTT also from |nRFVSC|. For detailed instructions, see `How to connect to the terminal`_ on the `nRF Connect for Visual Studio Code`_ documentation site. SEGGER's J-Link RTT Viewer is available for Windows, Linux, and macOS. diff --git a/doc/nrf/test_and_optimize/debugging.rst b/doc/nrf/test_and_optimize/debugging.rst index c0d0ff278eac..d0604053f8e3 100644 --- a/doc/nrf/test_and_optimize/debugging.rst +++ b/doc/nrf/test_and_optimize/debugging.rst @@ -13,7 +13,7 @@ The tool uses `Microsoft's debug adaptor`_ and integrates custom debugging featu .. tabs:: - .. group-tab:: nRF Connect for Visual Studio Code + .. group-tab:: nRF Connect for VS Code Use nRF Debug after adding the required Kconfig options to the :file:`prj.conf` file. For details, see the `How to debug an application`_ section in the |nRFVSC| documentation. From cd77aa18e23379731751ccf60e22bee94045cd49 Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc Date: Wed, 27 Aug 2025 10:38:26 +0200 Subject: [PATCH 2/2] doc: 21540ek_dev_guide typos Fixed typos and style in 21540ek_dev_guide.rst. NCSDK-NONE. Requested by @umapraseeda. Signed-off-by: Grzegorz Ferenc --- .../device_guides/fem/21540ek_dev_guide.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst b/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst index 812ec0eefd54..f34d772afc74 100644 --- a/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst +++ b/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst @@ -51,22 +51,22 @@ When building for a board with an additional network core, like the nRF5340, add west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek In this case, the sysbuild will pass the *SHIELD=nrf21540ek* variable to all images that are built by the command. -The build system will pick automatically appropriate overlay and configuration files for images for each core. +The build system will automatically pick appropriate overlay and configuration files for images for each core. Please note that the files are different for each of the cores. -For the application core the overlay containing forwarding the FEM pins to the network core will be used. -For the network core the overlay enabling nRF21540 FEM on the network core will be used. -In case the application contains additional images for which the *SHIELD* variable should not be passed, you must pass manually the *SHIELD* variable to each relevant image build separately. +For the application core, the overlay containing forwarding of the FEM pins to the network core will be used. +For the network core, the overlay enabling nRF21540 FEM on the network core will be used. +In case the application contains additional images for which the *SHIELD* variable should not be passed, you must manually pass the *SHIELD* variable to each relevant image build separately. .. code-block:: console west build -b nrf5340dk/nrf5340/cpuapp -- -D_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek -In this case the *SHIELD=nrf21540ek* will be passed to the build of the *app_image_name* image for the application core. -The build system will pick automatically an overlay file containing forwarding the FEM pins to the network core. +In this case, the *SHIELD=nrf21540ek* will be passed to the build of the *app_image_name* image for the application core. +The build system will automatically pick an overlay file containing forwarding of the FEM pins to the network core. The *SHIELD=nrf21540ek* variable will be passed to the build of the ``ipc_radio`` image for the network core. -The build system will pick automatically an overlay file enabling nRF21540 FEM on the network core. +The build system will automatically pick an overlay file enabling nRF21540 FEM on the network core. -In this command, the ``ipc_radio`` image us used as default and builds the network core image with support for the combination of 802.15.4 and Bluetooth. +In this command, the ``ipc_radio`` image is used as default and builds the network core image with support for the combination of 802.15.4 and Bluetooth. The ``ipc_radio`` has been used since the build system migration to sysbuild. See :ref:`Migrating to sysbuild ` page. Setting the correct sysbuild option enables support for 802.15.4 and Bluetooth :ref:`ipc_radio`. @@ -75,7 +75,7 @@ Setting the correct sysbuild option enables support for 802.15.4 and Bluetooth : You can configure your application using the following sysbuild configurations: * ``SB_CONFIG_NETCORE_IPC_RADIO=y`` for applications having support for 802.15.4, but not for Bluetooth. -* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for application having support for Bluetooth, but not for 802.15.4. +* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for applications having support for Bluetooth, but not for 802.15.4. * ``SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.