summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTrevor Woerner <twoerner@gmail.com>2025-05-06 14:03:01 -0400
committerSteve Sakoman <steve@sakoman.com>2025-05-19 08:57:20 -0700
commitfafdc5bd96590245eeab32b863c5f3f4fc4106b7 (patch)
treeff07f705009585551d8eb276229e1146efdfe732
parenteed3e6c2c83a9ad71bebb863e80e36c822bdd3e3 (diff)
downloadpoky-fafdc5bd96590245eeab32b863c5f3f4fc4106b7.tar.gz
sphinx-lint: various fixes
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) (From yocto-docs rev: 9f4fab1727bcf010cd3631ce5ae769797b9fba99) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1020d82aff4dab5b3d64e7035e87763a80cf5b70) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/dev-manual/devtool.rst2
-rw-r--r--documentation/dev-manual/start.rst4
-rw-r--r--documentation/migration-guides/migration-5.2.rst2
-rw-r--r--documentation/migration-guides/release-notes-5.2.rst4
-rw-r--r--documentation/ref-manual/variables.rst4
5 files changed, 8 insertions, 8 deletions
diff --git a/documentation/dev-manual/devtool.rst b/documentation/dev-manual/devtool.rst
index 2f17d50930..c82dc9c333 100644
--- a/documentation/dev-manual/devtool.rst
+++ b/documentation/dev-manual/devtool.rst
@@ -552,7 +552,7 @@ the two modes:
552 552
553 This instance of VSCode uses plugins that are useful for the development 553 This instance of VSCode uses plugins that are useful for the development
554 of the application. ``devtool ide-sdk`` generates the necessary 554 of the application. ``devtool ide-sdk`` generates the necessary
555 ``extensions.json``, ``settings.json``, ``tasks.json``and ``launch.json`` 555 ``extensions.json``, ``settings.json``, ``tasks.json`` and ``launch.json``
556 configuration files for all the involved plugins. 556 configuration files for all the involved plugins.
557 557
558 When the source code folder present in the workspace folder is opened in 558 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 0f015d4340..21d3dce58c 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -860,7 +860,7 @@ Initializing the Build Environment
860Before you can use Yocto you need to setup the build environment. 860Before you can use Yocto you need to setup the build environment.
861From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment 861From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment
862setup script to define Yocto Project's build environment on your build host:: 862setup script to define Yocto Project's build environment on your build host::
863 863
864 $ source oe-init-build-env 864 $ source oe-init-build-env
865 865
866Note, that this step will have to be repeated every time you open a new shell. 866Note, 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 9e9f466ade..77a11fe270 100644
--- a/documentation/migration-guides/migration-5.2.rst
+++ b/documentation/migration-guides/migration-5.2.rst
@@ -83,7 +83,7 @@ systemd changes
83 files by starting them via 83 files by starting them via
84 `Also <https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html#Also=>`__, 84 `Also <https://www.freedesktop.org/software/systemd/man/latest/systemd.unit.html#Also=>`__,
85 the other service files were automatically added to the :term:`FILES` variable of 85 the other service files were automatically added to the :term:`FILES` variable of
86 the same package. Example: 86 the same package. Example:
87 87
88 a.service contains:: 88 a.service contains::
89 89
diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst
index 03f454bfc0..f0223b5f72 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|
25 :ref:`Shared State <overview-manual/concepts:Shared State>` for the 25 :ref:`Shared State <overview-manual/concepts:Shared State>` for the
26 dependencies. See :doc:`/test-manual/reproducible-builds`. 26 dependencies. See :doc:`/test-manual/reproducible-builds`.
27 27
28 - ``systemd``: Add term:`WATCHDOG_RUNTIME_SEC`: for controlling the 28 - ``systemd``: Add :term:`WATCHDOG_RUNTIME_SEC`: for controlling the
29 ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``. 29 ``RuntimeWatchdogSec`` option in ``/etc/systemd/system.conf``.
30 30
31 - :term:`FIT_UBOOT_ENV` to allow including a u-boot script as a text in a 31 - :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|
671 - New ``bbverbnote`` log utility which can be used to print on the console 671 - New ``bbverbnote`` log utility which can be used to print on the console
672 (equivalent to the ``bb.verbnote`` Python implementation). 672 (equivalent to the ``bb.verbnote`` Python implementation).
673 673
674 - :ref:``ref-classes-grub-efi``: Add :term:`GRUB_TITLE` variable to set 674 - :ref:`ref-classes-grub-efi`: Add :term:`GRUB_TITLE` variable to set
675 custom GRUB titles. 675 custom GRUB titles.
676 676
677 - ``gawk``: Enable high precision arithmetic support by default (``mpfr`` 677 - ``gawk``: Enable high precision arithmetic support by default (``mpfr``
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 295035c760..501bfecaf0 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.
6131 By default, no API key is used, which results in larger delays between API 6131 By default, no API key is used, which results in larger delays between API
6132 requests and limits the number of queries to the public rate limits posted 6132 requests and limits the number of queries to the public rate limits posted
6133 at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__. 6133 at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__.
6134 6134
6135 NVD API keys can be requested through the 6135 NVD API keys can be requested through the
6136 `Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__ 6136 `Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__
6137 page. You can set this variable to the NVD API key in your ``local.conf`` file. 6137 page. You can set this variable to the NVD API key in your ``local.conf`` file.
@@ -10399,7 +10399,7 @@ system and gives an overview of their function and contents.
10399 10399
10400 UBOOT_FIT_TEE_IMAGE ?= "tee-raw.bin" 10400 UBOOT_FIT_TEE_IMAGE ?= "tee-raw.bin"
10401 10401
10402 If a relative path is provided, the file is expected to be relative to 10402 If a relative path is provided, the file is expected to be relative to
10403 U-Boot's :term:`B` directory. An absolute path can be provided too, 10403 U-Boot's :term:`B` directory. An absolute path can be provided too,
10404 e.g.:: 10404 e.g.::
10405 10405