Skip to content

Commit

Permalink
doc: sphinx-lint: fix dangling-hyphen
Browse files Browse the repository at this point in the history
Dangling hyphens at the end of a line are usually a problem, ie. you
have an "hyphenated-word" and breaking it on two line will render it as
"hyphenated- word".
This commit fixes the few occurences of such dangling hyphens.

Signed-off-by: Benjamin Cabé <[email protected]>
  • Loading branch information
kartben committed Sep 10, 2024
1 parent 72513b2 commit f402e86
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion boards/blues/swan_r5/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Due to its novel design, for high-volume deployment the low-cost Swan
can also be soldered directly to a parent PCB integrating those sensors,
utilizing the full range of Swan's I/O capabilities.

The board has three independent power options-USB, Battery, or Line power-
The board has three independent power options-USB, Battery, or Line power,
and provides a software-switchable 2 Amp regulator for powering external
sensors. When operating in its low-power operating mode, the entire Swan
board commonly draws only about 8uA while retaining all of its memory,
Expand Down
4 changes: 2 additions & 2 deletions doc/build/dts/api-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,8 @@ Here are pointers to some other available APIs.

- :c:func:`DT_CHOSEN`, :c:func:`DT_HAS_CHOSEN`: for properties
of the special ``/chosen`` node
- :c:func:`DT_HAS_COMPAT_STATUS_OKAY`, :c:func:`DT_NODE_HAS_COMPAT`: global-
and node-specific tests related to the ``compatible`` property
- :c:func:`DT_HAS_COMPAT_STATUS_OKAY`, :c:func:`DT_NODE_HAS_COMPAT`: global- and
node-specific tests related to the ``compatible`` property
- :c:func:`DT_BUS`: get a node's bus controller, if there is one
- :c:func:`DT_ENUM_IDX`: for properties whose values are among a fixed list of
choices
Expand Down
4 changes: 2 additions & 2 deletions doc/connectivity/networking/api/net_l2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,8 @@ here as well. There are two specific differences however:
packet will often have to be split into several fragments and IP6 packet headers
and fragments need to be compressed using a protocol like 6LoWPAN before being
passed on to the radio driver. Additionally the IEEE 802.15.4 standard defines
medium access (e.g. CSMA/CA), frame retransmission, encryption and other pre-
processing procedures (e.g. addition of information elements) that individual
medium access (e.g. CSMA/CA), frame retransmission, encryption and other pre-processing
procedures (e.g. addition of information elements) that individual
radio drivers should not have to care about. This is why the
:c:struct:`ieee802154_radio_api` requires a tx function pointer which differs
from the :c:struct:`net_if_api` send function pointer. Zephyr's native
Expand Down
4 changes: 2 additions & 2 deletions doc/hardware/porting/arch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -745,8 +745,8 @@ privilege elevation stack must be allocated elsewhere.
:c:macro:`Z_POW2_CEIL()`. :c:macro:`K_THREAD_STACK_RESERVED` must be 0.

For the privilege stacks, the :kconfig:option:`CONFIG_GEN_PRIV_STACKS` must be,
enabled. For every thread stack found in the system, a corresponding fixed-
size kernel stack used for handling system calls is generated. The address
enabled. For every thread stack found in the system, a corresponding fixed-size
kernel stack used for handling system calls is generated. The address
of the privilege stacks can be looked up quickly at runtime based on the
thread stack address using :c:func:`z_priv_stack_find()`. These stacks are
laid out the same way as other kernel-only stacks.
Expand Down
4 changes: 2 additions & 2 deletions doc/kernel/services/threads/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ met:

- There may need to be additional memory reserved for memory management
structures
- If guard-based stack overflow detection is enabled, a small write-
protected memory management region must immediately precede the stack buffer
- If guard-based stack overflow detection is enabled, a small write-protected
memory management region must immediately precede the stack buffer
to catch overflows.
- If userspace is enabled, a separate fixed-size privilege elevation stack must
be reserved to serve as a private kernel stack for handling system calls.
Expand Down
8 changes: 4 additions & 4 deletions doc/kernel/usermode/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,11 @@ For threads running in a non-privileged CPU state (hereafter referred to as
- We prevent invoking system calls to functions excluded by the kernel
configuration.

- We prevent disabling of or tampering with kernel-defined and hardware-
enforced memory protections.
- We prevent disabling of or tampering with kernel-defined and
hardware-enforced memory protections.

- We prevent re-entry from user to supervisor mode except through the kernel-
defined system calls and interrupt handlers.
- We prevent re-entry from user to supervisor mode except through the
kernel-defined system calls and interrupt handlers.

- We prevent the introduction of new executable code by user mode threads,
except to the extent to which this is supported by kernel system calls.
Expand Down
4 changes: 2 additions & 2 deletions samples/boards/bbc_microbit/pong/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ to select the current choice. To start the game, the player with the
ball launches the ball by pressing both buttons.

When multi-player mode has been selected the game will try to look for
and connect to a second micro:bit which has also been set into multi-
player mode.
and connect to a second micro:bit which has also been set into multi-player
mode.

If the board has a piezo buzzer connected to pin 0, this will be used to
generate beeps whenever the ball hits a wall or the paddle.
Expand Down

0 comments on commit f402e86

Please sign in to comment.