Skip to content

Commit dfbcdb9

Browse files
umapraseedarlubos
authored andcommitted
doc: Documentation fixes
Documentation fixes Signed-off-by: Uma Praseeda <uma.praseeda@nordicsemi.no>
1 parent e7aecdd commit dfbcdb9

File tree

97 files changed

+197
-183
lines changed

Some content is hidden

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

97 files changed

+197
-183
lines changed

applications/asset_tracker_v2/src/events/app_module_event.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ enum app_module_event_type {
3434
APP_EVT_LTE_DISCONNECT,
3535

3636
/** Signal other modules to start sampling and report the data when
37-
* it's ready.
37+
* it is ready.
3838
* The event must also contain a list with requested data types,
3939
* @ref app_module_data_type.
4040
*/

applications/machine_learning/README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ If you build this application for the nRF53 DK, it enables additional features s
153153
See :ref:`ug_thingy53` for detailed information about the mentioned features.
154154

155155
The nRF53 DK has a J-Link debug IC that can be used to program the firmware.
156-
Alternatively, firmware can be updated over MCUBoot serial recovery or DFU over-the-air using Simple Management Protocol over Bluetooth.
156+
Alternatively, firmware can be updated over MCUboot serial recovery or DFU over-the-air using Simple Management Protocol over Bluetooth.
157157
Keep in mind that if you use bootloader to update firmware, the new firmware must be compatible with used bootloader and partition map.
158158

159159
The nRF53 Development Kit uses RTT as logger's backend.

applications/matter_bridge/doc/adding_ble_bridged_device_service.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ The following steps show how to add support for a new Bluetooth LE service calle
240240
return bt_gatt_subscribe(mDevice.mConn, &mGattSubscribeParams);
241241
}
242242
243-
#. Add the ``MyBtServiceDataProvider`` implementation created in a previous steps to the compilation process.
243+
#. Add the ``MyBtServiceDataProvider`` implementation created in a previous step to the compilation process.
244244
To do that, edit the :file:`CMakeLists.txt` file as follows:
245245

246246
.. code-block:: cmake

applications/matter_bridge/doc/matter_bridge_description.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Button 1:
160160
:end-before: matter_door_lock_sample_led1_end
161161

162162
LED 2:
163-
If the :kconfig:option:`CONFIG_BRIDGED_DEVICE_BT` kconfig option is set to ``y``, shows the current state of Bridge's Bluetooth LE connectivity.
163+
If the :kconfig:option:`CONFIG_BRIDGED_DEVICE_BT` Kconfig option is set to ``y``, shows the current state of Bridge's Bluetooth LE connectivity.
164164
The following states are possible:
165165

166166
* Turned Off - The Bridge device is in the idle state and has no Bluetooth LE devices paired.

applications/nrf_desktop/README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -992,8 +992,8 @@ Measuring HID report rate
992992
You can measure a HID report rate of your application to assess the performance of your HID device.
993993
This measurement allows you to check how often the host computer can get user's input from the HID device.
994994

995-
Prerequsites
996-
~~~~~~~~~~~~
995+
Prerequisites
996+
~~~~~~~~~~~~~
997997

998998
The HID report rate can be measured by using either browser-based or platform-specific tools.
999999
You can use any preferred HID report rate tool.

applications/nrf_desktop/doc/battery_charger.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ For this reason, you should set :kconfig:option:`CONFIG_GPIO` option.
2828
By default, the module is disabled and the :ref:`CONFIG_DESKTOP_BATTERY_CHARGER_NONE <config_desktop_app_options>` option is selected.
2929
Set the option :ref:`CONFIG_DESKTOP_BATTERY_CHARGER_DISCRETE <config_desktop_app_options>` to enable the module.
3030

31-
The module requires a node labeled ``battery_charger`` with a ``battery-charger`` compatible set in Devicetree.
31+
The module requires a node labeled ``battery_charger`` with a ``battery-charger`` compatible set in devicetree.
3232
The charge status output (CSO) GPIO spec, the Enable GPIO spec, and the CSO switching frequency properties are also required.
3333
See the following snippet for an example:
3434

applications/nrf_desktop/doc/ble_qos.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Enable the module using the :ref:`CONFIG_DESKTOP_BLE_QOS_ENABLE <config_desktop_
3333
The option selects :kconfig:option:`CONFIG_BT_HCI_VS_EVT_USER`, because the module uses vendor-specific HCI events.
3434

3535
You can use the :ref:`CONFIG_DESKTOP_BLE_QOS_STATS_PRINTOUT_ENABLE <config_desktop_app_options>` option to enable real-time QoS information printouts through a UART (e.g. a virtual COM port).
36-
The chosen UART needs to be specified in Devicetree using ``ncs,ble-qos-uart``.
36+
The chosen UART needs to be specified in devicetree using ``ncs,ble-qos-uart``.
3737
This option also enables and configures the COM port (USB CDC ACM).
3838
For this reason, the :kconfig:option:`CONFIG_USB_DEVICE_STACK` must be enabled.
3939

applications/nrf_desktop/doc/fast_pair_app.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The option is enabled by default if :kconfig:option:`CONFIG_CAF_BLE_STATE_MAX_LO
4646
.. note::
4747
If :kconfig:option:`CONFIG_CAF_BLE_STATE_MAX_LOCAL_ID_BONDS` Kconfig option value is equal to one:
4848

49-
* Displaying UI indication during the Fast Pair not discoverable advertising (:kconfig:option:`CONFIG_BT_ADV_PROV_FAST_PAIR_SHOW_UI_PAIRING`) is disabled by default in the nRF Desktop advertising data configuration defined in :file:`src/util/Kconfg` file.
49+
* Displaying UI indication during the Fast Pair not discoverable advertising (:kconfig:option:`CONFIG_BT_ADV_PROV_FAST_PAIR_SHOW_UI_PAIRING`) is disabled by default in the nRF Desktop advertising data configuration defined in :file:`src/util/Kconfig` file.
5050
* :ref:`nrf_desktop_ble_state` automatically disconnects new peers right after Bluetooth connection is established if the used Bluetooth local identity is already bonded with another peer.
5151

5252
The :ref:`CONFIG_DESKTOP_FAST_PAIR_LIMIT_NORMAL_PAIRING <config_desktop_app_options>` can be used to allow normal Bluetooth pairing only in the pairing mode.

applications/serial_lte_modem/doc/slm_description.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ CONFIG_SLM_NATIVE_TLS_CREDENTIAL_BUFFER_SIZE - Buffer space reserved for loading
8484

8585
CONFIG_SLM_NATIVE_TLS_CREDENTIAL_BUFFER_COUNT - Number of buffers for loading credentials
8686
The number of buffers available for loading ``sec_tag`` credentials for Mbed TLS.
87-
TLS client only needs the buffer when connecting, while TLS server needs the buffer as long as it running.
87+
TLS client only needs the buffer when connecting, while TLS server needs the buffer as long as it is running.
8888
Increase the value if you need both TLS client and server running simultaneously with different ``sec_tags``.
8989
The default value is ``1``.
9090

@@ -246,7 +246,7 @@ CONFIG_SLM_TWI - TWI support in SLM
246246
.. _CONFIG_SLM_UART_RX_BUF_COUNT:
247247

248248
CONFIG_SLM_UART_RX_BUF_COUNT - Receive buffers for UART.
249-
This option defines the amount of buffers for receiving (RX) UART traffic.
249+
This option defines the number of buffers for receiving (RX) UART traffic.
250250
The default value is 3.
251251

252252
.. _CONFIG_SLM_UART_RX_BUF_SIZE:

applications/serial_lte_modem/src/gnss/slm_at_gnss.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ static void gnss_status_set(enum gnss_status status)
127127
/* A notification is sent when the GNSS status is updated.
128128
* However this gets called in interrupt context (from gnss_event_handler()),
129129
* from which UART messages cannot be sent. This task is thus delegated
130-
* to a worker, to which the the new GNSS status is passed.
130+
* to a worker, to which the new GNSS status is passed.
131131
* A FIFO rather than a single variable is used to not miss GNSS status changes
132132
* in case they happen twice (or more) before the worker had the time to process them.
133133
*/

doc/nrf/config_and_build/bootloaders/bootloader_config.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ However, there are other ways to customize your application using Kconfig option
2020
Using custom project configurations
2121
***********************************
2222

23-
You can use custom project configuration options for the associated image, specifying them at build time using :ref:`ug_multi_image_variables`, either temporarily until you clean the build pristinely or permamently.
23+
You can use custom project configuration options for the associated image, specifying them at build time using :ref:`ug_multi_image_variables`, either temporarily until you clean the build pristinely or permanently.
2424

2525
For example, you can temporarily assign custom project configurations for both the bootloaders and a sample application as follows:
2626

doc/nrf/config_and_build/bootloaders/bootloader_signature_keys.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Dedicated host tools like :doc:`mcuboot:imgtool` can be used to sign application
1414
When you use |NSIB|, a private/public key pair is by default generated during the build when you are :ref:`ug_bootloader_adding_immutable_keys`.
1515
You can use the methods described in the following sections to explicitly define how the key pair is to be generated.
1616

17-
When you use MCUboot or you are :ref:`ug_bootloader_adding_upgradable_mcuboot`, MCUBoot uses keys that were generated once and are stored in the public MCUboot Git repository be default.
17+
When you use MCUboot or you are :ref:`ug_bootloader_adding_upgradable_mcuboot`, MCUboot uses keys that were generated once and are stored in the public MCUboot Git repository by default.
1818

1919
.. note::
2020
These key pairs should only be used during development.

doc/nrf/dev_model_and_contributions/adding_code.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ This repository showcases the following features of both the |NCS| and Zephyr:
128128
* Custom :ref:`devicetree bindings <zephyr:dt-bindings>`
129129
* Out-of-tree :ref:`drivers <zephyr:device_model_api>`
130130
* Out-of-tree libraries
131-
* Example CI configuration (using Github Actions)
131+
* Example CI configuration (using GitHub Actions)
132132
* Custom :ref:`west extension <zephyr:west-extensions>`
133133

134134
.. example_app_end

doc/nrf/dev_model_and_contributions/code_base.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ nRF repositories
9393
* Usually licensed for use on Nordic products only.
9494

9595
nRF repositories are stand-alone and have no upstreams, since they are unique to the |NCS|.
96-
Some examples of repositories of this type are:
96+
Following are some examples of this type of repositories:
9797

9898
* `sdk-nrf`_: The main repository for Nordic-developed software.
9999
* `sdk-nrfxlib`_: A repository containing linkable libraries developed by Nordic.

doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -598,9 +598,9 @@ If not changed, then the default child image prefix for MCUboot is ``mcuboot_``
598598

599599
.. note::
600600

601-
The application core can be reverted, but doing so bricks the network core upon revertion, as the reversion process fills the network core with the content currently in the RAM that pcd uses.
602-
To enable this, define the ``USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY`` Kconfig option in the project-level Kconfig file.
603-
When this is option is defined, you can enable it by setting :kconfig:option`CONFIG_USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY`.
601+
The application core can be reverted, but doing so breaks the network core upon reversal, as the reversion process fills the network core with the content currently in the RAM that PCD uses.
602+
To enable this, define the :kconfig:option:`CONFIG_USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY` Kconfig option in the project-level Kconfig file.
603+
When this option is defined, you can enable it by setting :kconfig:option:`CONFIG_USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY`.
604604

605605
The :kconfig:option:`CONFIG_NRF53_MULTI_IMAGE_UPDATE` option selects this feature by default if these options and all its other dependencies are asserted.
606606

doc/nrf/device_guides/working_with_nrf/nrf70/developing/fw_patches_ext_flash.rst

+16-16
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Firmware patches in the external memory
1010
This guide explains the available options for having the nRF70 Series firmware patches reside in the external memory.
1111

1212
.. note::
13-
External memory refers to the memory that is outside the SoC, for example, an external flash memory chip, or external non-volatile memory (NVM) chip etc.
13+
External memory refers to the memory that is outside the SoC, for example, an external flash memory chip, or external non-volatile memory (NVM) chip.
1414

1515
Overview
1616
********
1717

18-
By default the nRF70 Series firmware patches are built as part of the nRF Wi-Fi driver code, residing in on-chip memory.
18+
By default, the nRF70 Series firmware patches are built as part of the nRF Wi-Fi driver code, residing in on-chip memory.
1919
The firmware patches include code that is executed on the nRF70 Series device.
20-
The size of the firmware patches may be considerably large, which limits the amount of on-chip code memory available for the user application.
20+
The size of the firmware patches might be considerably large, which limits the amount of on-chip code memory available for the user application.
2121
In order to increase the amount of on-chip memory available for user applications, the nRF Wi-Fi driver supports the option of using external memory, if that is available.
2222

2323
Prerequisites
@@ -30,7 +30,7 @@ Before using this feature, make sure that the following prerequisites are comple
3030
The maximum size of all the firmware patches combined is 128 KB.
3131

3232
.. note::
33-
Currently, in Nordic Semiconductor SoCs, access to external memory and the Execute in Place (XIP) feature are available through the QSPI interface only.
33+
Currently, in Nordic Semiconductor SoCs, access to external memory and the Execute in Place (XIP) feature are available through the QSPI interface only.
3434

3535
Supported platforms
3636
===================
@@ -41,7 +41,7 @@ The following platforms are supported:
4141
* nRF52840 DK with nRF7002 EK as a shield
4242

4343
.. note::
44-
Due to limitations mentioned above, the nRF7002 DK is not supported as it needs access to external memory through the SPI interface.
44+
Due to limitations mentioned above, the nRF7002 DK is not supported as it needs access to external memory through the SPI interface.
4545

4646
Available options
4747
*****************
@@ -56,12 +56,12 @@ Using XIP access
5656

5757
If the application supports XIP from external memory, then the firmware patches can be loaded as part of the nRF Wi-Fi driver code (RODATA) and then relocated to the external memory.
5858
The nRF Wi-Fi driver accesses the firmware patches using XIP feature and downloads the firmware patches to the nRF70 device.
59-
To enable this feature, set the :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_XIP` kconfig option to ``y``.
59+
To enable this feature, set the :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_XIP` Kconfig option to ``y``.
6060
Once the build is complete, the feature can be verified by checking the memory regions summary in the build output.
6161
A new memory region called ``EXTFLASH`` is added to the memory regions summary, and the firmware patches are placed in this region.
6262
The size of the ``FLASH`` used is reduced by the size of the firmware patches.
6363

64-
A sample memory regions summary is shown below:
64+
Following is a sample summary of the memory regions:
6565

6666
.. code-block:: console
6767
@@ -77,8 +77,8 @@ Using QSPI transfers to RAM
7777
The nRF Wi-Fi driver supports the option for offloading the nRF70 firmware patch to external non-XIP memory.
7878
In this case the upload of the firmware patch from the external memory to the nRF70 device happens in two stages:
7979

80-
* first the firmware patch is loaded from the external memory onto internal RAM and
81-
* then it is uploaded to the nRF70 device.
80+
1. The firmware patch is loaded from the external memory onto internal RAM.
81+
#. The firmware patch is uploaded to the nRF70 device.
8282

8383
This feature can be enabled using DTS or :ref:`snippets` feature or by using :ref:`partition_manager`.
8484

@@ -87,13 +87,13 @@ Configuration
8787

8888
The following configuration options are available:
8989

90-
* :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_STORE`: Enables the option to store the firmware patch in external non-XIP memory.
91-
* :kconfig:option:`CONFIG_NRF_WIFI_FW_FLASH_CHUNK_SIZE`: Defines the size of the chunks used to read the firmware patches from the external non-XIP memory.
90+
* :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_STORE` - Enables the option to store the firmware patch in external non-XIP memory.
91+
* :kconfig:option:`CONFIG_NRF_WIFI_FW_FLASH_CHUNK_SIZE` - Defines the size of the chunks used to read the firmware patches from the external non-XIP memory.
9292
The default value is 8192 bytes.
9393

9494
The external memory partition name must be defined in the devicetree or in the partition manager configuration file.
9595

96-
* ``nrf70_fw_partition``: Defines the name of the external memory partition that stores the firmware patches.
96+
* ``nrf70_fw_partition`` - Defines the name of the external memory partition that stores the firmware patches.
9797
This must be defined in the devicetree, for example:
9898

9999
.. code-block:: dts
@@ -110,7 +110,7 @@ The external memory partition name must be defined in the devicetree or in the p
110110
};
111111
};
112112
113-
* ``nrf70_wifi_fw`` : Defines the name of the external memory partition that stores the firmware patches.
113+
* ``nrf70_wifi_fw`` - Defines the name of the external memory partition that stores the firmware patches.
114114
This must be defined in the partition manager configuration file, for example:
115115

116116
.. code-block:: console
@@ -128,7 +128,7 @@ See :ref:`nrf7002dk_nrf5340` for general instructions on building.
128128

129129
Additionally, you must enable either the `nrf70-fw-patch-ext-flash` snippet or the :kconfig:option:`CONFIG_PARTITION_MANAGER_ENABLED` option.
130130

131-
For example, to build the :ref:`wifi_shell_sample` sample for the nRF5340 DK with the ``nrf70-fw-patch-ext-flash`` snippet enabled, run the following commands:
131+
For example, to build the :ref:`wifi_shell_sample` sample for the nRF5340 DK with the ``nrf70-fw-patch-ext-flash`` snippet enabled, run the following commands.
132132

133133
With west
134134
^^^^^^^^^
@@ -165,7 +165,7 @@ With CMake
165165
Programming
166166
-----------
167167

168-
To program the firmware image with the firmware patches stored in the external memory, use the following commands:
168+
To program the firmware image with the firmware patches stored in the external memory, use the following commands.
169169

170170
With west
171171
^^^^^^^^^
@@ -185,7 +185,7 @@ For example, for nrfjprog:
185185

186186
.. code-block:: console
187187
188-
nrfjprog -f nrf53 -s 0 --program build/zephyr/merged.hex ---sectorerase --qspisectorerase --verify --reset
188+
nrfjprog -f nrf53 -s 0 --program build/zephyr/merged.hex ---sectorerase --qspisectorerase --verify --reset
189189
190190
Updating firmware patches
191191
=========================

doc/nrf/device_guides/working_with_nrf/nrf70/nrf7002eb_gs.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The nRF7002 EB can be used to provide Wi-Fi® connectivity to compatible develop
1414
The nRF7002 EB has a :term:`Printed Circuit Board (PCB)` edge connector that can be used with a compatible development board such as the Nordic Thingy:53, an IoT prototyping platform from Nordic Semiconductor.
1515
There are also castellated holes on the side of the board that allow the EB to be used as a breakout board that can be soldered to other PCB assemblies.
1616

17-
If this is your first time developing with a Nordic DK, read the appropriate getting started tutorial first:
17+
If this is your first time developing with a Nordic Semiconductor DK, read the appropriate getting started tutorial first:
1818

1919
* :ref:`ug_nrf7002_gs`
2020
* :ref:`ug_thingy53_gs`

doc/nrf/device_guides/working_with_nrf/nrf70/nrf7002ek_gs.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The kit can be used to provide Wi-Fi® connectivity and Wi-Fi-based locationing
1515
The nRF7002 EK features the nRF7002 companion IC.
1616
In addition, the shield may be used to emulate the nRF7001 and nRF7000 companion IC variants.
1717

18-
If this is your first time developing with a Nordic DK, read the appropriate getting started tutorial first:
18+
If this is your first time developing with a Nordic Semiconductor DK, read the appropriate getting started tutorial first:
1919

2020
* :ref:`ug_nrf7002_gs`
2121
* :ref:`ug_nrf52_gs`

doc/nrf/device_guides/working_with_nrf/nrf91/nrf91_features.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -258,12 +258,13 @@ You can hardcode the information in the application, or you can use a functional
258258
Samples and applications implementing FOTA
259259
==========================================
260260

261-
* :ref:`http_modem_full_update_sample` sample - performs a full firmware OTA update of the modem.
262-
* :ref:`http_modem_delta_update_sample` sample - performs a delta OTA update of the modem firmware.
263-
* :ref:`http_application_update_sample` sample - performs a basic application FOTA update.
264-
* :ref:`aws_iot` sample - performs a FOTA update using MQTT and HTTP, where the firmware download is triggered through an AWS IoT job.
265-
* :ref:`azure_iot_hub` sample - performs a FOTA update from the Azure IoT Hub.
266-
* :ref:`asset_tracker_v2` application - performs FOTA updates of the application, modem (delta), and boot (if enabled). It also supports nRF Cloud FOTA as well as AWS or Azure FOTA. Only one must be configured at a time.
261+
* :ref:`http_modem_full_update_sample` sample - Performs a full firmware OTA update of the modem.
262+
* :ref:`http_modem_delta_update_sample` sample - Performs a delta OTA update of the modem firmware.
263+
* :ref:`http_application_update_sample` sample - Performs a basic application FOTA update.
264+
* :ref:`aws_iot` sample - Performs a FOTA update using MQTT and HTTP, where the firmware download is triggered through an AWS IoT job.
265+
* :ref:`azure_iot_hub` sample - Performs a FOTA update from the Azure IoT Hub.
266+
* :ref:`asset_tracker_v2` application - Performs FOTA updates of the application, modem (delta), and boot (if enabled).
267+
It also supports nRF Cloud FOTA as well as AWS or Azure FOTA. Only one must be configured at a time.
267268

268269
.. _nrf91_ug_gnss:
269270
.. _nrf9160_ug_gnss:

0 commit comments

Comments
 (0)