From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH] sphinx-lint: various fixes
Date: Tue, 6 May 2025 14:03:01 -0400 [thread overview]
Message-ID: <20250506180301.32610-1-twoerner@gmail.com> (raw)
A 'make sphinx-lint' pass found the following issues:
trailing-whitespace
missing-space-after-literal
role-with-double-backticks
missing-space-before-role (role missing opening tag colon)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
documentation/dev-manual/devtool.rst | 2 +-
documentation/dev-manual/start.rst | 4 ++--
documentation/migration-guides/migration-5.2.rst | 2 +-
documentation/migration-guides/release-notes-5.2.rst | 4 ++--
documentation/ref-manual/variables.rst | 4 ++--
5 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/documentation/dev-manual/devtool.rst b/documentation/dev-manual/devtool.rst
index 2f17d5093048..c82dc9c3334a 100644
--- a/documentation/dev-manual/devtool.rst
+++ b/documentation/dev-manual/devtool.rst
@@ -552,7 +552,7 @@ the two modes:
This instance of VSCode uses plugins that are useful for the development
of the application. ``devtool ide-sdk`` generates the necessary
- ``extensions.json``, ``settings.json``, ``tasks.json``and ``launch.json``
+ ``extensions.json``, ``settings.json``, ``tasks.json`` and ``launch.json``
configuration files for all the involved plugins.
When the source code folder present in the workspace folder is opened in
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 0f015d434041..21d3dce58c14 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -860,7 +860,7 @@ Initializing the Build Environment
Before you can use Yocto you need to setup the build environment.
From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment
setup script to define Yocto Project's build environment on your build host::
-
- $ source oe-init-build-env
+
+ $ source oe-init-build-env
Note, that this step will have to be repeated every time you open a new shell.
diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
index 9e9f466ade1e..77a11fe27047 100644
--- a/documentation/migration-guides/migration-5.2.rst
+++ b/documentation/migration-guides/migration-5.2.rst
@@ -83,7 +83,7 @@ systemd changes
files by starting them via
`Also <https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html#Also=>`__,
the other service files were automatically added to the :term:`FILES` variable of
- the same package. Example:
+ the same package. Example:
a.service contains::
diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst
index 03f454bfc080..f0223b5f7290 100644
--- a/documentation/migration-guides/release-notes-5.2.rst
+++ b/documentation/migration-guides/release-notes-5.2.rst
@@ -25,7 +25,7 @@ New Features / Enhancements in |yocto-ver|
:ref:`Shared State <overview-manual/concepts:Shared State>` for the
dependencies. See :doc:`/test-manual/reproducible-builds`.
- - ``systemd``: Add term:`WATCHDOG_RUNTIME_SEC`: for controlling the
+ - ``systemd``: Add :term:`WATCHDOG_RUNTIME_SEC`: for controlling the
``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``.
- :term:`FIT_UBOOT_ENV` to allow including a u-boot script as a text in a
@@ -671,7 +671,7 @@ New Features / Enhancements in |yocto-ver|
- New ``bbverbnote`` log utility which can be used to print on the console
(equivalent to the ``bb.verbnote`` Python implementation).
- - :ref:``ref-classes-grub-efi``: Add :term:`GRUB_TITLE` variable to set
+ - :ref:`ref-classes-grub-efi`: Add :term:`GRUB_TITLE` variable to set
custom GRUB titles.
- ``gawk``: Enable high precision arithmetic support by default (``mpfr``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d17f81036b7d..6a7c265d6b60 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6131,7 +6131,7 @@ system and gives an overview of their function and contents.
By default, no API key is used, which results in larger delays between API
requests and limits the number of queries to the public rate limits posted
at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__.
-
+
NVD API keys can be requested through the
`Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__
page. You can set this variable to the NVD API key in your ``local.conf`` file.
@@ -10404,7 +10404,7 @@ system and gives an overview of their function and contents.
UBOOT_FIT_TEE_IMAGE ?= "tee-raw.bin"
- If a relative path is provided, the file is expected to be relative to
+ If a relative path is provided, the file is expected to be relative to
U-Boot's :term:`B` directory. An absolute path can be provided too,
e.g.::
--
2.44.0.501.g19981daefd7c
next reply other threads:[~2025-05-06 18:03 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-06 18:03 Trevor Woerner [this message]
2025-05-12 7:50 ` [docs] [PATCH] sphinx-lint: various fixes Quentin Schulz
2025-05-12 21:03 ` Trevor Woerner
2025-05-13 8:17 ` Antonin Godard
2025-05-13 13:16 ` Trevor Woerner
2025-05-16 13:34 ` Antonin Godard
2025-05-21 16:42 ` Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250506180301.32610-1-twoerner@gmail.com \
--to=twoerner@gmail.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.