Skip to content

Commit 012b7ba

Browse files
divipillairlubos
divipillai
authored and
rlubos
committed
doc: Minor fixes to docs
Minor fixes to following pages: * Matter Bridge applications * nrf91_snippet.rst * application_update sample Signed-off-by: divya pillai <[email protected]>
1 parent 26d92e2 commit 012b7ba

File tree

3 files changed

+99
-25
lines changed

3 files changed

+99
-25
lines changed

‎applications/matter_bridge/doc/matter_bridge_description.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -734,8 +734,7 @@ Configure the functionality of the Matter-Bridge device
734734

735735
To enable the Matter smart plugin functionality, run the following command with *board_target* replaced with the board target name:
736736

737-
.. parsed-literal::
738-
:class: highlight
737+
.. tabs::
739738

740739
.. group-tab:: nRF54 DKs
741740

‎doc/nrf/app_dev/device_guides/nrf91/nrf91_snippet.rst‎

Lines changed: 97 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,31 @@ nRF91 modem traces with flash backend using snippets
4040
The ``nrf91-modem-trace-ext-flash`` snippet enables modem tracing, the flash backend, and external flash and configures them to store modem traces to a dedicated partition on the external flash for supported boards.
4141
To change the partition size, the project needs to configure the :kconfig:option:`CONFIG_NRF_MODEM_LIB_TRACE_BACKEND_FLASH_PARTITION_SIZE` Kconfig option.
4242

43-
To enable modem traces with the flash backend, use the following command pattern, where *board_target* corresponds to your board target and `<image_name>` to your application image name:
43+
To enable modem traces with the flash backend, add the ``nrf91-modem-trace-ext-flash`` snippet to the :term:`build configuration`.
44+
You can do this in one of the following ways:
4445

45-
.. parsed-literal::
46-
:class: highlight
46+
.. tabs::
47+
48+
.. group-tab:: west
49+
50+
To add the modem traces with the flash backend snippet when building an application with west, use the following command pattern, where *board_target* corresponds to your board target and `<image_name>` to your application image name:
4751

48-
west build --board *board_target* -- -D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash"
52+
.. parsed-literal::
53+
:class: highlight
54+
55+
west build --board *board_target* -- -D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash"
56+
57+
.. group-tab:: CMake
58+
59+
To add the modem traces with the flash backend snippet when building an application with CMake, add the following command to the CMake arguments:
60+
61+
.. code-block:: console
62+
63+
-D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash" [...]
64+
65+
To build with the |nRFVSC|, specify ``-D<image_name>_SNIPPET="nrf91-modem-trace-ext-flash" [...]`` in the **Extra CMake arguments** field.
66+
67+
See :ref:`cmake_options` for more details.
4968

5069
.. _nrf91_modem_trace_ram_snippet:
5170

@@ -55,12 +74,31 @@ nRF91 modem traces with RAM backend using snippets
5574
The ``nrf91-modem-trace-ram`` snippet enables modem tracing and configures it to store modem traces to a dedicated partition on the RAM.
5675
To change the partition size, the project needs to configure the :kconfig:option:`CONFIG_NRF_MODEM_LIB_TRACE_BACKEND_RAM_LENGTH` Kconfig option.
5776

58-
To enable modem traces with the RAM backend, use the following command pattern, where *board_target* corresponds to your board target and `<image_name>` to your application image name:
77+
To enable modem traces with the RAM backend, add the ``nrf91-modem-trace-ram`` snippet to the :term:`build configuration`.
78+
You can do this in one of the following ways:
5979

60-
.. parsed-literal::
61-
:class: highlight
80+
.. tabs::
81+
82+
.. group-tab:: west
83+
84+
To add modem traces with the RAM backend when building an application with west, use the following command pattern, where *board_target* corresponds to your board target and `<image_name>` to your application image name:
6285

63-
west build --board *board_target* -- -D<image_name>_SNIPPET="nrf91-modem-trace-ram"
86+
.. parsed-literal::
87+
:class: highlight
88+
89+
west build --board *board_target* -- -D<image_name>_SNIPPET="nrf91-modem-trace-ram"
90+
91+
.. group-tab:: CMake
92+
93+
To add the modem traces with the RAM backend snippet when building an application with CMake, add the following command to the CMake arguments:
94+
95+
.. code-block:: console
96+
97+
-D<image_name>_SNIPPET="nrf91-modem-trace-ram" [...]
98+
99+
To build with the |nRFVSC|, specify ``-D<image_name>_SNIPPET="nrf91-modem-trace-ram" [...]`` in the **Extra CMake arguments** field.
100+
101+
See :ref:`cmake_options` for more details.
64102

65103
.. _nrf91_modem_trace_uart_snippet:
66104

@@ -74,8 +112,8 @@ If this configuration does not match your requirements, you can add a snippet or
74112
.. note::
75113
If you are using the nRF9160 DK, remember to :ref:`set the board controller switch to the **nRF91** position <build_pgm_nrf9160_board_controller>` before programming.
76114

77-
To enable modem tracing with the UART trace backend on a nRF91 device, add the ``nrf91-modem-trace-uart`` snippet to the :term:`build configuration`.
78-
This can be done in one of the following ways:
115+
To enable modem tracing with the UART trace backend on a nRF91 Series device, add the ``nrf91-modem-trace-uart`` snippet to the :term:`build configuration`.
116+
You can do this in one of the following ways:
79117

80118
.. tabs::
81119

@@ -98,7 +136,7 @@ This can be done in one of the following ways:
98136

99137
.. code-block:: console
100138
101-
-D<image_name>_SNIPPET="nrf91-modem-trace-uart" [...]
139+
-D<image_name>_SNIPPET="nrf91-modem-trace-uart" [...]
102140
103141
To build with the |nRFVSC|, specify ``-D<image_name>_SNIPPET="nrf91-modem-trace-uart" [...]`` in the **Extra CMake arguments** field.
104142

@@ -111,22 +149,61 @@ nRF91 modem traces with RTT backend using snippets
111149

112150
The ``nrf91-modem-trace-rtt`` snippet enables the :kconfig:option:`CONFIG_NRF_MODEM_LIB_TRACE` Kconfig option and chooses the RTT trace backend with the necessary Kconfig options.
113151

114-
To enable modem traces with the RTT backend, use the following command pattern, where *board_target* corresponds to your board target and `<image_name>` to your application image name:
152+
To enable modem tracing with the RTT backend, add the ``nrf91-modem-trace-rtt`` snippet to the :term:`build configuration`.
153+
You can do this in one of the following ways:
115154

116-
.. parsed-literal::
117-
:class: highlight
155+
.. tabs::
156+
157+
.. group-tab:: west
158+
159+
To add modem traces with the RTT backend when building an application with west, use the following command pattern, where *board_target* corresponds to your board target and `<image_name>` to your application image name:
118160

119-
west build --board *board_target* -- -D<image_name>_SNIPPET="nrf91-modem-trace-rtt"
161+
.. parsed-literal::
162+
:class: highlight
163+
164+
west build --board *board_target* -- -D<image_name>_SNIPPET="nrf91-modem-trace-rtt"
165+
166+
.. group-tab:: CMake
167+
168+
To add the modem traces with the RTT backend snippet when building an application with CMake, add the following command to the CMake arguments:
169+
170+
.. code-block:: console
171+
172+
-D<image_name>_SNIPPET="nrf91-modem-trace-rtt" [...]
173+
174+
To build with the |nRFVSC|, specify ``-D<image_name>_SNIPPET="nrf91-modem-trace-rtt" [...]`` in the **Extra CMake arguments** field.
175+
176+
See :ref:`cmake_options` for more details.
120177

121178
.. _tfm_enable_share_uart:
122179

123180
Shared UART for application and TF-M logging
124181
********************************************
125182

126-
If you want to activate TF-M logging while having modem traces enabled, it can be useful to direct the TF-M logs to the UART (**UART0**) used by the application.
127-
To activate both modem traces and TF-M logs, use the following command pattern, where *board_target* corresponds to your board target:
183+
If you want to activate TF-M logging while having modem traces with the UART backend enabled, it can be useful to direct the TF-M logs to the UART (**UART0**) used by the application.
184+
185+
To enable modem traces and TF-M logs, add the ``nrf91-modem-trace-uart`` and ``tfm-enable-share-uart`` snippets to the :term:`build configuration`.
186+
You can do this in one of the following ways:
128187

129-
.. parsed-literal::
130-
:class: highlight
188+
.. tabs::
131189

132-
west build --board *board_target* -S nrf91-modem-trace-uart -S tfm-enable-share-uart
190+
.. group-tab:: west
191+
192+
To activate both modem traces and TF-M logs when building an application with west, use the following command pattern, where *board_target* corresponds to your board target:
193+
194+
.. parsed-literal::
195+
:class: highlight
196+
197+
west build --board *board_target* -S nrf91-modem-trace-uart -S tfm-enable-share-uart
198+
199+
.. group-tab:: CMake
200+
201+
To activate TF-M logs when building an application with CMake, add the following command to the CMake arguments:
202+
203+
.. code-block:: console
204+
205+
-D<image_name>_SNIPPET="tfm-enable-share-uart" [...]
206+
207+
To build with the |nRFVSC|, specify ``-D<image_name>_SNIPPET="tfm-enable-share-uart" [...]`` in the **Extra CMake arguments** field.
208+
209+
See :ref:`cmake_options` for more details.

‎samples/cellular/http_update/application_update/README.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,7 @@ Specifying the image files
7777
==========================
7878

7979
Before building the sample, you must specify where the image files are located.
80-
If you do not want to host the files yourself, you can upload them to a public S3 bucket on Amazon Web Services (AWS).
81-
82-
If you do not want to host the image file, you can also upload it to a public S3 bucket on Amazon Web Services (AWS).
80+
If you do not want to host the image file, you can upload it to a public S3 bucket on Amazon Web Services (AWS).
8381

8482
.. include:: /includes/aws_s3_bucket.txt
8583

0 commit comments

Comments
 (0)