From f402e868e42ee31b9438e111d7d16979a4229973 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Tue, 10 Sep 2024 18:52:10 +0200 Subject: [PATCH] doc: sphinx-lint: fix dangling-hyphen MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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é --- boards/blues/swan_r5/doc/index.rst | 2 +- doc/build/dts/api-usage.rst | 4 ++-- doc/connectivity/networking/api/net_l2.rst | 4 ++-- doc/hardware/porting/arch.rst | 4 ++-- doc/kernel/services/threads/index.rst | 4 ++-- doc/kernel/usermode/overview.rst | 8 ++++---- samples/boards/bbc_microbit/pong/README.rst | 4 ++-- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/boards/blues/swan_r5/doc/index.rst b/boards/blues/swan_r5/doc/index.rst index 644e82e86dd95cd..616aae73b37a4e6 100644 --- a/boards/blues/swan_r5/doc/index.rst +++ b/boards/blues/swan_r5/doc/index.rst @@ -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, diff --git a/doc/build/dts/api-usage.rst b/doc/build/dts/api-usage.rst index b31c1e9baf36cd4..5bf0884c9124349 100644 --- a/doc/build/dts/api-usage.rst +++ b/doc/build/dts/api-usage.rst @@ -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 diff --git a/doc/connectivity/networking/api/net_l2.rst b/doc/connectivity/networking/api/net_l2.rst index eb502ab6ffe339d..dbdd336a592f59c 100644 --- a/doc/connectivity/networking/api/net_l2.rst +++ b/doc/connectivity/networking/api/net_l2.rst @@ -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 diff --git a/doc/hardware/porting/arch.rst b/doc/hardware/porting/arch.rst index 62b79cdb0323342..339b6642a257342 100644 --- a/doc/hardware/porting/arch.rst +++ b/doc/hardware/porting/arch.rst @@ -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. diff --git a/doc/kernel/services/threads/index.rst b/doc/kernel/services/threads/index.rst index 25d7ce8f53bd2f6..b9dd1fb3ba89578 100644 --- a/doc/kernel/services/threads/index.rst +++ b/doc/kernel/services/threads/index.rst @@ -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. diff --git a/doc/kernel/usermode/overview.rst b/doc/kernel/usermode/overview.rst index 50cc138453f4399..2af3d5d54556f71 100644 --- a/doc/kernel/usermode/overview.rst +++ b/doc/kernel/usermode/overview.rst @@ -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. diff --git a/samples/boards/bbc_microbit/pong/README.rst b/samples/boards/bbc_microbit/pong/README.rst index 46a03c87d8c8c47..f6fd9a3d48e8fe9 100644 --- a/samples/boards/bbc_microbit/pong/README.rst +++ b/samples/boards/bbc_microbit/pong/README.rst @@ -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.