Skip to content

Commit a77dcbe

Browse files
divipillairlubos
authored andcommitted
doc: Minor doc fixes
Minor doc fixes to the NCS docs. Signed-off-by: divya pillai <[email protected]>
1 parent 63145c4 commit a77dcbe

File tree

5 files changed

+14
-17
lines changed

5 files changed

+14
-17
lines changed

applications/nrf_desktop/doc/ble_bond.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ The module can go into one of the following standby states to make sure that the
171171

172172
Going into the standby states and leaving these states happens in reaction to the following events:
173173

174-
* ``power_down_event`` - On this event, the module goes into one of the standby states and the ongoing peer operation is cancelled.
174+
* ``power_down_event`` - On this event, the module goes into one of the standby states and the ongoing peer operation is canceled.
175175
* ``wake_up_event`` - On this event, the module returns from the standby state.
176176

177177
.. figure:: /images/nrf_desktop_ble_bond_standby.svg

applications/nrf_desktop/doc/usb_state_pm.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ It depends on the options :ref:`CONFIG_DESKTOP_USB_ENABLE <config_desktop_app_op
3131

3232
The log level is inherited from the :ref:`nrf_desktop_usb_state`.
3333

34-
System Power Management integration
34+
System power management integration
3535
===================================
3636

37-
Zephyr's System Power Management (:kconfig:option:`CONFIG_PM`) does not automatically take into account (expect) wakeups related to user input and finalized HID report transfers over USB.
37+
Zephyr's system power management (:kconfig:option:`CONFIG_PM`) does not automatically take into account (expect) wakeups related to user input and finalized HID report transfers over USB.
3838
This results in entering low power states if no work is scheduled to be done in the nearest future.
39-
If you use Zephyr's System Power Management, the module automatically requires zero latency in the Power Management while USB is active.
39+
If you use Zephyr's system power management, the module automatically requires zero latency in the power management while USB is active.
4040
This is done to prevent entering power states that introduce wakeup latency and ensure high performance.
4141
You can control this feature using the :ref:`CONFIG_DESKTOP_USB_PM_REQ_NO_PM_LATENCY <config_desktop_app_options>` Kconfig option.
4242

@@ -59,9 +59,9 @@ The application power level is imposed using the :c:struct:`power_manager_restri
5959
The module restricts the power down level to the :c:enum:`POWER_MANAGER_LEVEL_SUSPENDED`.
6060
The module also submits a :c:struct:`force_power_down_event` to force a quick power down.
6161

62-
System Power Management latency
62+
System power management latency
6363
===============================
6464

65-
The latency requirements of the System Power Management are updated using the :c:func:`pm_policy_latency_request_add` and :c:func:`pm_policy_latency_request_remove` functions.
65+
The latency requirements of the system power management are updated using the :c:func:`pm_policy_latency_request_add` and :c:func:`pm_policy_latency_request_remove` functions.
6666
The zero latency requirement is added when USB state is set to :c:enum:`USB_STATE_ACTIVE`.
6767
The requirement is removed if USB enters another state.

doc/nrf/libraries/modem/at_params.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ AT parameters
77
:local:
88
:depth: 2
99

10-
.. important::
10+
.. note::
1111
The AT parameters module is deprecated.
1212

1313
The AT parameters module provides functionality to store lists of AT command or respond parameters.

samples/bluetooth/peripheral_uart/README.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,6 @@ User interface
109109

110110
The user interface of the sample depends on the hardware platform you are using.
111111

112-
Development kits
113-
================
114-
115112
.. tabs::
116113

117114
.. group-tab:: nRF21, nRF52 and nRF53 DKs

scripts/docker/README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The image is based on Linux - Ubuntu 22.04 Docker image with the following addit
1616
* ``device``
1717

1818
* |NCS| toolchain bundle
19-
* JLink |jlink_ver| (installation requires accepting SEGGER License)
19+
* SEGGER J-Link |jlink_ver| (installation requires accepting SEGGER License)
2020

2121
Building image
2222
**************
@@ -29,16 +29,16 @@ You can use `print_toolchain_checksum.sh`_ to get ID proper for your |NCS| revis
2929
TOOLCHAIN_ID=$(../print_toolchain_checksum.sh)
3030
docker build --build-arg VERSION=$TOOLCHAIN_ID
3131
32-
Accepting JLink license
33-
***********************
32+
Accepting J-Link license
33+
************************
3434

35-
To install and use JLink software you have to accept `JLink License Agreement`_.
35+
To install and use J-Link software you have to accept `JLink License Agreement`_.
3636

3737
If the container is run in an interactive mode, you will be asked to accept the license at the start of the container.
3838

39-
You can also start the container with the ``ACCEPT_JLINK_LICENSE=1`` environment variable, and JLink will be installed without prompting.
39+
You can also start the container with the ``ACCEPT_JLINK_LICENSE=1`` environment variable, and J-Link will be installed without prompting.
4040

41-
During post installation steps, JLink configures ``udev`` roles.
41+
During post installation steps, J-Link configures ``udev`` roles.
4242
This operation requires running a container with the ``--privileged`` flag to grant permissions needed for the container.
4343

4444
Running container
@@ -79,7 +79,7 @@ GitHub Actions
7979

8080
GitHub action starts container with overwritten default entry point. That means you have to set ``bash`` as a default shell to load all required environment variables.
8181

82-
If the container is started with the ``ACCEPT_JLINK_LICENSE`` env variable set to ``1``, JLink will be installed just before the first bash command is executed.
82+
If the container is started with the ``ACCEPT_JLINK_LICENSE`` env variable set to ``1``, J-Link will be installed just before the first bash command is executed.
8383

8484
Example job configuration:
8585

0 commit comments

Comments
 (0)