Skip to content

Commit

Permalink
doc: wayland: update for the extension release
Browse files Browse the repository at this point in the history
Updated documentation pages for the latest changes to the extension.
VSC-2735, VSC-2760, VSC-2340.

Signed-off-by: Grzegorz Ferenc <[email protected]>
  • Loading branch information
greg-fer committed Dec 10, 2024
1 parent 9b0cd12 commit 5af1a5e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
9 changes: 5 additions & 4 deletions doc/nrf/app_dev/create_application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,17 +171,18 @@ Use the following steps depending on the application placement:
The application creation process starts after you enter the name.
When the application is created, a VS Code prompt appears asking you what to do with the application.
#. Click :guilabel:`Open`.
This opens the new application and adds it to the :guilabel:`Applications View` in the extension.
This will open the new application and adds it to the :guilabel:`Applications View` in the extension.
At this point, you have created a freestanding application.
#. Add the :file:`west.yml` to create a west workspace around the application:

a. In the :guilabel:`Welcome View`, click the :guilabel:`Manage SDKs` action.
A quick pick menu appears.
#. Click :guilabel:`Create west workspace`.
#. Click :guilabel:`Manage West Workspace...`.
#. In the :guilabel:`Manage West Workspace...` action menu, click :guilabel:`Create West Workspace`.
#. Enter a location for the :file:`west.yml` file that matches the location provided in step 4.
#. Select the SDK version for the west workspace.
The west workspace is initialized and the :guilabel:`Manage SDKs` action changes to :guilabel:`Manage west workspace`.
#. Click :guilabel:`Manage west workspace` and select :guilabel:`West Update` button to update the workspace modules.
The west workspace is initialized.
#. Click :guilabel:`Manage SDKs` > :guilabel:`Manage West Workspace` > :guilabel:`West Update` to update the workspace modules.

You can now start :ref:`configuring and building <configuration_and_build>` the application.

Expand Down
20 changes: 13 additions & 7 deletions doc/nrf/installation/install_ncs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,12 @@ Depending on your preferred development environment, complete the following step
The list of available stable toolchain versions appears in the |VSC|'s quick pick.
#. Select the toolchain version to install.
The toolchain version should match the |NCS| version you are going to work with.
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).
If you are working with a development tag, disable the filter in the quick pick's header to list all available toolchains.
|install_latest_version|

.. note::
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).
If you are working with a development tag, disable the filter in the quick pick's header to list all available toolchains.

The toolchain installation starts in the background, as can be seen in the notification that appears.

When you install the toolchain for the first time, the installed version is automatically selected for your project.
Expand Down Expand Up @@ -138,14 +142,17 @@ Depending on your preferred development environment, complete the following step
For example:

.. code-block:: console
.. parsed-literal::
:class: highlight
nrfutil toolchain-manager install --ncs-version v2.0.0
nrfutil toolchain-manager install --ncs-version |release|
This example command installs the toolchain required for the |NCS| v2.0.0.
This example command installs the toolchain required for the |NCS| |release|.
|install_latest_version|

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

If you have received a custom URL for installing the toolchain, you can use the following command to set it as default, replacing the respective parameter:
Expand All @@ -162,8 +169,7 @@ Depending on your preferred development environment, complete the following step
nrfutil toolchain-manager install --bundle-id *custom_bundle_ID*
To check the current configuration setting, use the ``nrfutil toolchain-manager config --show`` command.
To read more about these commands, use the ``nrfutil toolchain-manager --help`` command.
To read more about ``toolchain-manager`` commands, use the ``nrfutil toolchain-manager --help`` command.

With the default location to install the toolchain (:file:`C:/ncs/toolchains` on Windows, :file:`~/ncs/toolchains/` on Linux, and the non-modifiable :file:`/opt/nordic/ncs/toolchains/` on macOS), your directory structure now looks similar to this:

Expand Down
3 changes: 2 additions & 1 deletion doc/nrf/test_and_optimize/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@ Use the following steps to enable monitor-mode debugging in the |NCS|:
2. Attach the debugger to the application.
3. Depending on debugger you are using, enable monitor-mode debugging:

* For nRF Debug in the |nRFVSC|, enter ``-exec monitor exec SetMonModeDebug=1`` in the debug console.
* For nRF Debug in the |nRFVSC|, the monitor-mode is automatically enabled when you set the :kconfig:option:`CONFIG_SEGGER_DEBUGMON` Kconfig option and build your application.
(``-exec monitor exec SetMonModeDebug=1`` is automatically passed to the debug console).
* For debugging using Ozone, enter ``Exec.Command("SetMonModeDebug = 1");`` in the console.

For more information about monitor-mode debugging, see Zephyr's :ref:`zephyr:debugmon` documentation and SEGGER's `Monitor-mode Debugging <Monitor-mode Debugging_>`_ documentation.
Expand Down

0 comments on commit 5af1a5e

Please sign in to comment.