Skip to content

Commit 370ae8e

Browse files
umapraseedaanangl
authored andcommitted
doc: Doc fixes
Doc fixes Signed-off-by: Uma Praseeda <uma.praseeda@nordicsemi.no>
1 parent 4830e8c commit 370ae8e

File tree

59 files changed

+217
-180
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+217
-180
lines changed

applications/ipc_radio/README.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ You can set the supported radio configurations using the following Kconfig optio
6868

6969
You can select the Bluetooth Low Energy serialization using the :kconfig:option:`CONFIG_IPC_RADIO_BT_SER` Kconfig option:
7070

71-
* :kconfig:option:`CONFIG_IPC_RADIO_BT_HCI_IPC` - For the Bluetooh HCI serialization.
72-
* :kconfig:option:`CONFIG_IPC_RADIO_BT_RPC` - For the Bluetooh host API serialization.
71+
* :kconfig:option:`CONFIG_IPC_RADIO_BT_HCI_IPC` - For the Bluetooth HCI serialization.
72+
* :kconfig:option:`CONFIG_IPC_RADIO_BT_RPC` - For the Bluetooth host API serialization.
7373

7474
The Bluetooth Low Energy and IEEE 802.15.4 functionalities can operate simultaneously and are only limited by available memory.
7575

@@ -101,9 +101,9 @@ The following files are available:
101101

102102
.. note::
103103
When you use sysbuild to build an application which uses the ipc_radio as network core image the preceding configuration files are added automatically to ipc_radio.
104-
The selection of specific configuration files is determined by the sysbuild kconfig.
104+
The selection of specific configuration files is determined by the sysbuild Kconfig.
105105

106-
For instance the :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO_IEEE802154` kconfig enables the :file:`overlay-802154.conf` configuration file to be used with ipc_radio.
106+
For instance, the :kconfig:option:`SB_CONFIG_NETCORE_IPC_RADIO_IEEE802154` Kconfig option enables the :file:`overlay-802154.conf` configuration file to be used with IPC radio firmware.
107107

108108
Building and running as a single image
109109
**************************************

applications/machine_learning/common/src/modules/Kconfig.event_proxy

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ menuconfig ML_APP_EVENT_PROXY
1111
select APP_EVENT_MANAGER_POSTINIT_HOOK
1212
help
1313
Enable and initialize event manager proxy subsystem on application
14-
start. Subscribtion to events is done based on configuration file.
14+
start. Subscription to events is done based on configuration file.
1515

1616
if ML_APP_EVENT_PROXY
1717

@@ -20,8 +20,8 @@ config ML_APP_REMOTE_CORE_INITIALIZATION_TIMEOUT
2020
range 10 10000
2121
default 2000
2222
help
23-
The time to wait for remote cores to report its readines. The time is
24-
given in miliseconds.
23+
The time to wait for remote cores to report its readiness. The time is
24+
given in milliseconds.
2525

2626
module = ML_APP_EVENT_PROXY
2727
module-str = event proxy module

applications/matter_bridge/doc/matter_bridge_description.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ Controlling a simulated On/Off Light bridged device
225225
uart:~$ matter_bridge onoff 1 3
226226
227227
Note that the above command will only work if the :ref:`CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_SHELL <CONFIG_BRIDGED_DEVICE_SIMULATED_ONOFF_SHELL>` option is selected in the build configuration.
228-
If the Kconfig option is not selected, the simulated device changes its state periodically in autonomous manner and can not be controlled by using shell commands.
228+
If the Kconfig option is not selected, the simulated device changes its state periodically in autonomous manner and cannot be controlled by using shell commands.
229229

230230
Controlling a simulated On/Off Light Switch bridged device
231231
Use the following command:
@@ -416,7 +416,7 @@ If you selected the Bluetooth LE device implementation using the :ref:`CONFIG_BR
416416
.. _CONFIG_BRIDGE_BT_MAX_SCANNED_DEVICES:
417417

418418
CONFIG_BRIDGE_BT_MAX_SCANNED_DEVICES
419-
Set the maximum amount of scanned devices.
419+
Set the maximum number of scanned devices.
420420

421421
.. _CONFIG_BRIDGE_BT_MINIMUM_SECURITY_LEVEL:
422422

applications/nrf_desktop/description.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nRF Desktop: Application description
77
:local:
88
:depth: 2
99

10-
The nRF Desktop application supports common input hardware interfaces like motion sensors, rotation sensors, and buttons martixes.
10+
The nRF Desktop application supports common input hardware interfaces like motion sensors, rotation sensors, and buttons matrixes.
1111
You can configure the firmware at runtime using a dedicated configuration channel established with the HID feature report.
1212
The same channel is used to transmit DFU packets.
1313

applications/nrf_desktop/doc/wheel.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Enable the module with the :ref:`CONFIG_DESKTOP_WHEEL_ENABLE <config_desktop_app
2727
For detecting rotation, the wheel module uses Zephyr's QDEC driver.
2828
You can enable the module only when QDEC is configured in DTS and the Zephyr's QDEC driver is enabled with the :kconfig:option:`CONFIG_QDEC_NRFX` Kconfig option.
2929
If your board supports multiple QDEC instances (for example ``nrf54l15pdk/nrf54l15/cpuapp``), you also need to specify the used QDEC instance with the ``nrfdesktop-wheel-qdec`` DT alias.
30-
If your board supports only one QDEC instance, the module relies on the ``qdec`` DT label and you do not need to define the DT alias.
30+
If your board supports only one QDEC instance, the module relies on the ``qdec`` DT label and you need not define the DT alias.
3131

3232
The QDEC DTS configuration specifies how many steps are done during one full angle.
3333
The sensor reports the rotation data in angle degrees.

applications/nrf_desktop/src/modules/Kconfig.hids

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ config DESKTOP_HIDS_SUBSCRIBER_PRIORITY
3737
range 1 255
3838
help
3939
HID Service over GATT reports subscriber priority. The lower value means the lower
40-
priority in subscribtion to HID reports. By default, the HID service uses the lowest
40+
priority in subscription to HID reports. By default, the HID service uses the lowest
4141
possible priority.
4242

4343
choice BT_HIDS_DEFAULT_PERM

applications/nrf_desktop/src/modules/Kconfig.usb_state

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ config DESKTOP_USB_SUBSCRIBER_REPORT_PRIORITY
2626
range 1 255
2727
help
2828
USB reports subscriber priority. The lower value means the lower
29-
priority in subscribtion to HID reports. By default, the USB uses the highest
29+
priority in subscription to HID reports. By default, the USB uses the highest
3030
possible priority.
3131

3232
config DESKTOP_USB_SELECTIVE_REPORT_SUBSCRIPTION

applications/serial_lte_modem/doc/CMUX_AT_commands.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ Syntax
5959

6060
The ``<AT_channel>`` parameter is an integer used to indicate the address of the AT channel.
6161
The AT channel denotes the CMUX channel where AT data (commands, responses, notifications) is exchanged.
62-
If specified, it must be 1, unlesss :ref:`PPP <CONFIG_SLM_PPP>` is enabled.
63-
If PPP is enabled, it can also be 2 (to allocate the first CMUX channel to PPP).
62+
If specified, it must be ``1``, unless :ref:`PPP <CONFIG_SLM_PPP>` is enabled.
63+
If PPP is enabled, it can also be ``2`` (to allocate the first CMUX channel to PPP).
6464
If not specified, the previously used address is used.
65-
If no address has been previously specified, the default address is 1.
65+
If no address has been previously specified, the default address is ``1``.
6666

6767
.. note::
6868

6969
If there is more than one CMUX channel (such as when using :ref:`PPP <CONFIG_SLM_PPP>`), the non-AT channels will automatically get assigned to addresses other than the one used for the AT channel.
70-
For example, if PPP is enabled and CMUX is started with the ``AT#XCMUX=2`` command, the AT channel will be assigned to address 2 and the PPP channel to address 1.
70+
For example, if PPP is enabled and CMUX is started with the ``AT#XCMUX=2`` command, the AT channel will be assigned to address ``2`` and the PPP channel to address ``1``.
7171

7272
An ``OK`` response is sent if the command is accepted, after which CMUX is started.
7373
This means that after successfully running this command, you must set up the CMUX link and open the channels appropriately.
@@ -99,7 +99,7 @@ Response syntax
9999
#XCMUX: <AT_channel>,<channel_count>
100100

101101
* The ``<AT_channel>`` parameter indicates the address of the AT channel.
102-
It is between 1 and ``<channel_count>``.
102+
It is between ``1`` and ``<channel_count>``.
103103
* The ``<channel_count>`` parameter is the total number of CMUX channels.
104104
It depends on what features are enabled (for example, :ref:`PPP <CONFIG_SLM_PPP>`).
105105

boards/shields/pca63565/doc/index.rst

+19-12
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,35 @@
33
PCA63565 shield
44
###############
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
Overview
711
********
812

913
PCA63565 is a testing shield with following sensors:
10-
- ADXL362 - accelerometer (SPI interface);
11-
- BMI270 - accelerometer and gyroscope (SPI interface),
12-
- BME688 - temperature, pressure, humidity and gas sensor (I2C interface with on-board pull-up resistors 4.7 kohm).
13-
It is targeted for testing I2C, and SPI protocols drivers.
14+
15+
* ADXL362 - Accelerometer (SPI interface)
16+
* BMI270 - Accelerometer and gyroscope (SPI interface)
17+
* BME688 - Temperature, pressure, humidity and gas sensor (I2C interface with on-board pull-up resistors 4.7 kohm).
18+
It is targeted for testing I2C, and SPI protocols drivers.
1419

1520
Supply voltage - 1.8V
1621

1722
SPI interface:
18-
- SCK (P2.6)
19-
- MISO (P2.9)
20-
- MOSI (P2.8)
21-
- CS ADXL362 (P2.10)
22-
- CS BMI270 (P1.13)
23-
- IRQ from ADXL or BMI270 (selected with a jumper) (P1.14)
23+
24+
* SCK (P2.6)
25+
* MISO (P2.9)
26+
* MOSI (P2.8)
27+
* CS ADXL362 (P2.10)
28+
* CS BMI270 (P1.13)
29+
* IRQ from ADXL or BMI270 (selected with a jumper) (P1.14)
2430

2531
I2C interface:
26-
- SCL (P1.11)
27-
- SDA (P1.12)
32+
33+
* SCL (P1.11)
34+
* SDA (P1.12)
2835

2936
Requirements
3037
************

boards/shields/pca63566/doc/index.rst

+12-6
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,27 @@
33
PCA63566 shield
44
###############
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
Overview
711
********
812

913
PCA63566 is a testing shield with sensors and transceivers:
10-
- temperature,
11-
- humidity,
12-
- pressure,
13-
- accelerometer,
14-
- CAN transceiver
14+
15+
* Temperature
16+
* Humidity
17+
* Pressure
18+
* Accelerometer
19+
* CAN transceiver
20+
1521
It is targeted for testing I2C, I3C, SPI and CAN protocols drivers.
1622

1723
Requirements
1824
************
1925

20-
This shield is pin compatible with nrf54h20dk.
26+
This shield is pin compatible with nRF54H20 DK.
2127

2228
Usage
2329
*****

doc/nrf/config_and_build/board_support/defining_custom_board.rst

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Defining custom board
44
#####################
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
Defining your own board is a very common step in application development, because applications are typically designed to run on boards that are not directly supported by the |NCS|, and are often custom designs not available publicly.
711

812
Guidelines for custom boards

doc/nrf/config_and_build/configuring_app/output_build_files.rst

+4
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
Output build files (image files)
44
################################
55

6+
.. contents::
7+
:local:
8+
:depth: 2
9+
610
The building process produces each time an :term:`image file`.
711

812
The image file can refer to an *executable*, a *program*, or an *ELF file*.

doc/nrf/config_and_build/dfu/index.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,13 @@ Based on these criteria, the |NCS| offers support for the following DFU alternat
9090

9191
For device-specific guides related to DFU, see the following pages:
9292

93-
* :ref:`Developing with nRF52 Series <ug_nrf52_developing_ble_fota>` - for how to do firmware over-the-air (FOTA) updates with nRF52 Series devices.
93+
* :ref:`Developing with nRF52 Series <ug_nrf52_developing_ble_fota>` - For how to do firmware over-the-air (FOTA) updates with nRF52 Series devices.
9494

95-
* :ref:`Developing with nRF5340 DK <ug_nrf53_developing_ble_fota>` - for how to do FOTA updates and serial recovery with the nRF5340 SoC.
95+
* :ref:`Developing with nRF5340 DK <ug_nrf53_developing_ble_fota>` - For how to do FOTA updates and serial recovery with the nRF5340 SoC.
9696

97-
* :ref:`qspi_xip` - for external execute in place (XIP) for the nRF5340 SoC.
97+
* :ref:`qspi_xip` - For external execute in place (XIP) for the nRF5340 SoC.
9898

99-
* :ref:`ug_nrf70_fw_patch_update` - for nRF70 Series devices.
99+
* :ref:`ug_nrf70_fw_patch_update` - For nRF70 Series devices.
100100

101101
See the following user guides for an overview of topics related to general firmware updates with the |NCS|:
102102

doc/nrf/device_guides/nrf53/qspi_xip_guide_nrf5340.rst

+1
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,7 @@ If you wish to use the :file:`Qspi.ini` file, you will need to manually flash th
304304
For example, for the :ref:`smp_svr_ext_xip` sample, you need to flash the following files (paths are relative to the build directory):
305305

306306
* :file:`<cpunet_build_subdirectory>/zephyr/merged_CPUNET.hex`
307+
307308
* For Bluetooth stack application the path is :file:`<cpunet_build_subdirectory> hci_ipc`.
308309
* :file:`mcuboot/zephyr/zephyr.hex`
309310
* :file:`zephyr/internal_flash_signed.hex`

doc/nrf/device_guides/nrf53/serial_recovery.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To upload the networking image, use the following command::
1919
./mcumgr image upload <build_dir_path>/zephyr/net_core_app_update.bin -e -n 3 -c serial_conn
2020

2121
``serial_conn`` is the serial connection configuration.
22-
For more information on MCUmgr image management, see :ref:`zephyr:image_mgmt`
22+
For more information on MCUmgr image management, see :ref:`zephyr:image_mgmt`.
2323

2424
To enable the serial recovery of the network core while the multi-image update is not enabled in the MCUboot, set the following options:
2525

doc/nrf/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_matter_thread.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ Matter and Thread support has the following limitations on the nRF54H20 DK:
281281
* The ``west flash --erase`` command is blocked.
282282
See :ref:`ug_nrf54h20_gs_sample` for more information.
283283
* The factory reset functionality does not work properly.
284-
After clearing all NVM storage, the device can not reboot automatically and falls into a hard fault.
284+
After clearing all NVM storage, the device cannot reboot automatically and falls into a hard fault.
285285

286286
As a workaround, press the reset button on the nRF54H20 DK board after performing a factory reset.
287287
* Matter over Thread commissioning might be unstable due to the lack of true random generator support on nRF54H20.

doc/nrf/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_dfu.rst

+5-17
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ It consists of two main concepts: the SUIT envelope and the SUIT manifest.
2020
* The SUIT envelope acts as a secure container for transporting firmware updates, encapsulating the firmware binary and its manifest.
2121
* The SUIT manifest is a structured file with metadata essential for the update process, including firmware version, size, and hash for integrity verification.
2222

23-
Default manifest templates are provided by Nordic and used by default during application build.
23+
Default manifest templates are provided by Nordic Semiconductor and used by default during application build.
2424
These templates are suitable for simple cases and form the basis for generating SUIT envelopes and manifests tailored to specific application requirements.
2525
Customization of these templates is crucial for specific use cases and security requirements.
2626

@@ -62,7 +62,6 @@ Build system configuration
6262

6363
By default the build system generates SUIT envelopes using predefined manifest templates provided by Nordic Semiconductor.
6464
These templates can be found in :file:`modules/lib/suit-generator/ncs`, and are suitable for standard development needs.
65-
.
6665

6766
Three manifests are used in the most common case:
6867

@@ -98,7 +97,7 @@ The source of the manifest templates can be configured by setting the following
9897

9998
* :kconfig:option:`SB_CONFIG_SUIT_ENVELOPE_ROOT_TEMPLATE`
10099

101-
* :kconfig:option:`CONFIG_SUIT_ENVELOPE_TEMPLATE` - for each of the images (application and radio core images)
100+
* :kconfig:option:`CONFIG_SUIT_ENVELOPE_TEMPLATE` - For each of the images (application and radio core images)
102101

103102
One example is demonstrated with the following case:
104103

@@ -115,9 +114,7 @@ One example is demonstrated with the following case:
115114
The following files are used to create the SUIT envelope:
116115

117116
* Root envelope - :file:`root.yaml.jinja2`
118-
119117
* Application domain - :file:`app.yaml.jinja2`
120-
121118
* Radio domain - :file:`radio.yaml.jinja2`
122119

123120
To build the described example with the provided user-defined manifest templates:
@@ -188,11 +185,8 @@ Variables and methods available in the manifest templates
188185
The manifest templates have access to the following:
189186

190187
* Devicetree values (`edtlib`_ object)
191-
192188
* Target names
193-
194189
* Paths to binary artifacts
195-
196190
* Application version
197191

198192
Some of these values are stored in the Python dictionaries that are named after the target name.
@@ -201,23 +195,17 @@ For example, for the :ref:`nrf54h_suit_sample` there will be two variables avail
201195
The target names (the names of these variables) can be changed using the :kconfig:option:`CONFIG_SUIT_ENVELOPE_TARGET` Kconfig option for a given image.
202196
Each variable is a Python dictionary type (``dict``) containing the following keys:
203197

204-
* ``name`` - name of the target
205-
198+
* ``name`` - Name of the target
206199
* ``dt`` - Devicetree representation (`edtlib`_ object)
207-
208-
* ``binary`` - path to the binary, which holds the firmware for the target
200+
* ``binary`` - Path to the binary, which holds the firmware for the target
209201

210202
Additionally, the Python dictionary holds a variable called ``version`` that holds the application version.
211203
With the Python dictionary you are able to, for example:
212204

213205
* Extract the CPU ID by using ``application['dt'].label2node['cpu'].unit_addr``
214-
215206
* Obtain the partition address with ``application['dt'].chosen_nodes['zephyr,code-partition']``
216-
217207
* Obtain the size of partition with ``application['dt'].chosen_nodes['zephyr,code-partition'].regs[0].size``
218-
219208
* Get the pair of URI name and the binary path by using ``'#{{ application['name'] }}': {{ application['binary'] }}``
220-
221209
* Get the application version with ``suit-manifest-sequence-number: {{ sysbuild['config']['SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM'] }}``
222210

223211
Additionally, the **get_absolute_address** method is available to recalculate the absolute address of the partition.
@@ -406,7 +394,7 @@ To restore a YAML file from a binary SUIT envelope:
406394
Debug a SUIT envelope
407395
---------------------
408396

409-
To debug the a SUIT envelope, by printing their parsed content to the ``stdout``, run the following:
397+
To debug a SUIT envelope, by printing their parsed content to the ``stdout``, run the following:
410398

411399
.. code-block::
412400

doc/nrf/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_qsg.rst

+1-5
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,9 @@ Overview
1616
The following are basic SUIT concepts you need to understand to be able to customize SUIT DFU for your device:
1717

1818
* SUIT uses envelopes that serve as a secure transport container, and the SUIT manifest contains crucial deployment metadata.
19-
2019
* SUIT envelopes are generated from manifest templates.
21-
2220
* The SUIT manifest is like a blueprint that tells the system how to create a SUIT envelope, and contains instructions and metadata for the DFU procedure.
23-
2421
* Default SUIT manifest templates are provided, but customization, especially for UUIDs, is recommended.
25-
2622
* The manifest templates are automatically created and copied to the sample directory on the first build of SUIT samples.
2723

2824
.. figure:: images/nrf54h20_suit_dfu_overview.png
@@ -121,5 +117,5 @@ The SUIT DFU procedure can further be customized by:
121117
* Generating raw UUID values
122118
* Changing the default location of the manifests
123119

124-
Instructions for these actions and further customization are described in the :ref:`ug_nrf54h20_suit_customize_dfu`.
120+
Instructions for these actions and further customization are described in the :ref:`ug_nrf54h20_suit_customize_dfu` page.
125121
Additionally, you can modify SUIT components within the manifest (see the :ref:`ug_nrf54h20_suit_components` page for more information).

0 commit comments

Comments
 (0)