Skip to content

Commit 2cf084f

Browse files
umapraseedarlubos
authored andcommitted
doc: Doc check for 3.1.0
Doc check for 3.1.0 Signed-off-by: Uma Praseeda <[email protected]>
1 parent 19a963b commit 2cf084f

File tree

19 files changed

+30
-33
lines changed

19 files changed

+30
-33
lines changed

applications/nrf_desktop/bootloader_dfu.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ The serial recovery DFU is a feature of MCUboot and you need to enable it in the
330330
For the configuration details, see the :ref:`nrf_desktop_configuring_mcuboot_bootloader` section.
331331

332332
To start the serial recovery DFU, the device should boot into recovery mode, in which the bootloader is waiting for a new image upload to start.
333-
In the serial recovery DFU mode, the new image is transferred through an USB CDC ACM class instance.
333+
In the serial recovery DFU mode, the new image is transferred through a USB CDC ACM class instance.
334334
The bootloader overwrites the existing application located on the primary slot with the new application image.
335335
If the transfer is interrupted, the device cannot boot the incomplete application, and the image upload must be performed again.
336336

applications/nrf_desktop/doc/cpu_meas.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Configuration
2323
*************
2424

2525
To enable this module, use the :ref:`CONFIG_DESKTOP_CPU_MEAS_ENABLE <config_desktop_app_options>` Kconfig option.
26-
This option selects the :kconfig:option:`CONFIG_NRF_CPU_LOAD` option, which enables the :ref:`cpu_load` library that is used to perform the measurements.
26+
This option selects the :kconfig:option:`CONFIG_NRF_CPU_LOAD` Kconfig option, which enables the :ref:`cpu_load` library that is used to perform the measurements.
2727

2828
Set the time between subsequent CPU load measurements, in milliseconds, using the :ref:`CONFIG_DESKTOP_CPU_MEAS_PERIOD <config_desktop_app_options>` option.
2929

doc/nrf/app_dev/bootloaders_dfu/mcuboot_serial_recovery.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Uploading image
2727
By default, uploading an image is targeted to the primary slot.
2828
You can load an image to other slots only if you have enabled the ``CONFIG_MCUBOOT_SERIAL_DIRECT_IMAGE_UPLOAD`` Kconfig option.
2929
To use progressive slot erasing during image upload, enable the ``CONFIG_BOOT_ERASE_PROGRESSIVELY`` Kconfig option.
30-
As a result, a device can receive images smoothly and can erase required part of a flash automatically.
30+
As a result, a device can receive images smoothly and can erase the required part of a flash automatically.
3131

3232
Implementing serial recovery
3333
****************************

doc/nrf/app_dev/device_guides/fem/fem_nrf2220.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Enabling support for nRF2220
44
############################
55

66
The nRF2220 device is a range extender that you can use with nRF52, nRF53 and nRF54L Series devices.
7-
The nRF2220 features an GPIO and I2C interface.
7+
The nRF2220 features a GPIO and I2C interface.
88
You can use it to fully control your front-end module.
99
To use nRF2220, complete the following steps:
1010

@@ -45,7 +45,7 @@ To use nRF2220, complete the following steps:
4545
The nRF2220 features also a built-in low-attenuation bypass circuit.
4646
Either the bypass or power amplifier will be used when transmitting RF signals depending on requests made by a protocol driver.
4747
The control of the output power of the SoC and decision to use either the bypass or the power amplifier occurs automatically.
48-
#. Add a following I2C bus device node on the devicetree file:
48+
#. Add the following I2C bus device node on the devicetree file:
4949

5050
.. code-block:: devicetree
5151

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_mcuboot_dfu.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ MCUboot supports various methods for updating firmware images.
9393
On the nRF54H platform, you can use :ref:`swap and direct-xip modes<ug_bootloader_main_config>`.
9494

9595
For more information, see the :file:`samples/zephyr/subsys/mgmt/mcumgr/smp_svr` sample.
96-
This sample demonstrates how to configure DFU feature in both MCUBoot and user application in your project.
96+
This sample demonstrates how to configure DFU feature in both MCUboot and user application in your project.
9797
It uses Simple Management Protocol for DFU and querying device information from the application.
9898

9999
The following build flavours are available:
@@ -152,7 +152,7 @@ Additional Information
152152
**********************
153153

154154
You can test BLE-based FOTA samples with the `nRF Connect Device Manager`_.
155-
For DFU over a serial connection, use the :ref:`dfu_tools_mcumgr_cli` tool.
155+
For DFU over a serial connection, use the :ref:`dfu_tools_mcumgr_cli`.
156156

157157
.. note::
158158
On the nRF54H20 SoC, Direct XIP mode uses a merged image slot that combines both application and radio core images.

doc/nrf/app_dev/device_guides/nrf54l/kmu_provision.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,6 @@ If you set the ``SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE`` Kconfig option to a PE
152152
If not, the build will use the default key named :file:`GENERATED_NON_SECURE_SIGN_KEY_PRIVATE.pem`, which is located in the build directory.
153153
Similarly, MCUboot uses the key file designated by the :Kconfig:option:`SB_CONFIG_BOOT_SIGNATURE_KEY_FILE` option.
154154

155-
At the end of the described process the :file:`keyfile.json` file is generated in the build directory.
155+
At the end of the described process, the :file:`keyfile.json` file is generated in the build directory.
156156
This file allows key provisioning to occur simultaneously with the flashing process.
157157
Alternatively, you can bypass the mentioned Kconfig options and manually place a custom :file:`keyfile.json` in the build directory.

doc/nrf/app_dev/device_guides/nrf54l/vpr_flpr.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ However, the application core build must incorporate an overlay that enables the
3333
Bootstrapping the FLPR core
3434
===========================
3535

36-
The |NCS| provides a FLPR snippet that adds an overlay required for bootstrapping the FLPR core.
36+
The |NCS| provides an FLPR snippet that adds an overlay required for bootstrapping the FLPR core.
3737
Snippet's primary function is to enable the code that transfers the FLPR code to the designated region (if necessary) and to initiate the FLPR core.
3838

3939
When building for the ``nrf54l15dk/nrf54l15/cpuflpr`` target, a minimal sample is automatically loaded onto the application core.

doc/nrf/libraries/caf/leds.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ If the flag is not set, the sequence stops and the given LED effect ends.
347347
Power management events
348348
=======================
349349

350-
If the :kconfig:option:`CONFIG_CAF_LEDS_PM_EVENTS` Kconfig option is enabled, the module can react to following power management events:
350+
If the :kconfig:option:`CONFIG_CAF_LEDS_PM_EVENTS` Kconfig option is enabled, the module can react to the following power management events:
351351

352352
* ``power_down_event``
353353
* ``wake_up_event``

doc/nrf/libraries/caf/sensor_data_aggregator.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The aggregator is defined as a separate node in the devicetree and consists of t
6161
Implementation details
6262
**********************
6363

64-
|sensor_data_aggregator| subscribes to following sensor manager events:
64+
|sensor_data_aggregator| subscribes to the following sensor manager events:
6565

6666
* :c:struct:`sensor_state_event`
6767
* :c:struct:`sensor_event`

doc/nrf/libraries/networking/wifi_prov_core.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The protocol defines four message types:
7676
FORGET_CONFIG Erase the configuration and disconnect
7777
=================== ================================================ =============================
7878

79-
* ``Response``: The message is for the target to provide the feedback on the result of an action to the configurator.
79+
* ``Response`` - The message is for the target to provide the feedback on the result of an action to the configurator.
8080

8181
The following table details the fields of the ``Response`` message.
8282

@@ -88,14 +88,14 @@ The protocol defines four message types:
8888
device_status message Optional The status of the Wi-Fi on the target.
8989
=================== ======================= ======================== =======================================================================================
9090

91-
The ``status`` field can take one of following values:
91+
The ``status`` field can take one of the following values:
9292

93-
* ``SUCCESS``: The operation is dispatched successfully.
94-
* ``INVALID_ARGUMENT``: The argument is invalid.
95-
* ``INVALID_PROTO``: The message cannot be encoded or decoded.
96-
* ``INTERNAL_ERROR``: The operation cannot be dispatched properly.
93+
* ``SUCCESS`` - The operation is dispatched successfully.
94+
* ``INVALID_ARGUMENT`` - The argument is invalid.
95+
* ``INVALID_PROTO`` - The message cannot be encoded or decoded.
96+
* ``INTERNAL_ERROR`` - The operation cannot be dispatched properly.
9797

98-
* ``Result``: The message is for the target to provide feedback on the Wi-Fi status to the configurator asynchronously.
98+
* ``Result``- The message is for the target to provide feedback on the Wi-Fi status to the configurator asynchronously.
9999

100100
The following table details the fields of the ``Result`` message.
101101

0 commit comments

Comments
 (0)