Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion applications/nrf5340_audio/doc/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <known_issues_nrf5340audio>` before building and programming the applications.
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/app_dev/config_and_build/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Building an application
|application_sample_definition|

After you have :ref:`created an application <create_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 <app_build_system>`).
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/app_dev/config_and_build/cmake/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <How to work with build configurations_>`_ and `source and config files overview <Details View_>`_.

.. _modifying_files_compiler:
Expand Down Expand Up @@ -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_<suffix>.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:
Expand Down Expand Up @@ -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 <How to build 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <How to work with 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 <zephyr:application-kconfig>`
- :file:`Kconfig`, :file:`prj.conf`, :file:`.config`
- Software configuration system also used in the Linux kernel.
- `Kconfig GUI <Configuring with nRF Kconfig_>`_, :ref:`menuconfig and guiconfig <zephyr:menuconfig>`
- | Kconfig GUI is part of the |nRFVSC|.
- | Kconfig GUI is part of |nRFVSC|.
| The :ref:`Kconfig Reference <configuration_options>` provides the documentation for each configuration option.
* - :ref:`partition_manager`
- :file:`pm.yml`, :file:`pm_static.yml`
Expand Down Expand Up @@ -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 <How to create devicetree files_>`_ and work with them using the dedicated `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_.
In the |NCS|, you can use |nRFVSC| to `create the devicetree files <How to create devicetree files_>`_ and work with them using the dedicated `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_.
You can also select the devicetree files when :ref:`cmake_options`.

.. _configure_application_sw:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <How to work with 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 <How to work with Devicetree Visual Editor_>`_ (recommended).

For more advanced LED control, you can also use the :ref:`LEDs module <caf_leds>` of the :ref:`Common Application Framework (CAF) <lib_caf>`, which provides additional features, such as LED effects and power management integration.

Expand All @@ -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 <zephyr:set-devicetree-overlays>` or by using the |nRFVSC| (see `How to create devicetree files`_).
You can add them to your configuration :ref:`manually <zephyr:set-devicetree-overlays>` or by using |nRFVSC| (see `How to create devicetree files`_).

.. rst-class:: numbered-step

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/config_and_build/hardware/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Devicetree support overview_>`_, 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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <How to work with Devicetree Visual Editor_>`_ (either in GUI or text mode) in the |nRFVSC| to apply them.
You can also use the `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_ (either in GUI or text mode) in |nRFVSC| to apply them.

.. rst-class:: numbered-step

Expand Down
8 changes: 4 additions & 4 deletions doc/nrf/app_dev/config_and_build/kconfig/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,21 @@ 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.

.. tabs::

.. 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
Expand Down Expand Up @@ -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 <How to build an application_>`_.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
16 changes: 8 additions & 8 deletions doc/nrf/app_dev/create_application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,16 +138,16 @@ 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 <create_application_types_repository>`.
Creating repository applications is not recommended, as placing any application in the |NCS| source file structure can corrupt the SDK installation.

.. _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.
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
****************************
Expand All @@ -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.
Expand Down
20 changes: 10 additions & 10 deletions doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <How to work with build configurations_>`_.
If you use |nRFVSC|, specify ``-DSHIELD=nrf21540ek`` in the **Extra Cmake arguments** field when `setting up a build configuration <How to work with build configurations_>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you fix the typo in line 69 : 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in a separate commit.


Alternatively, add the shield in the project's :file:`CMakeLists.txt` file:

Expand All @@ -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<app_name_image>_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 <child_parent_to_sysbuild_migration>` page.
Setting the correct sysbuild option enables support for 802.15.4 and Bluetooth :ref:`ipc_radio`.
Expand All @@ -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.


Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/fem/2220ek_dev_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <How to work with build configurations_>`_.
If you use |nRFVSC|, specify ``-DSHIELD=nrf2220ek`` in the *Extra Cmake arguments* field when `setting up a build configuration <How to work with build configurations_>`_.

Alternatively, add the shield in the project's :file:`CMakeLists.txt` file:

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
Loading