소스 검색

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: 6d4c67457e00a80dda4cd05bc5f05d8ebd8da5fc)

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>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Trevor Woerner 3 주 전
부모
커밋
ec53c91af0

+ 1 - 1
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

+ 2 - 2
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.

+ 1 - 1
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::
 

+ 2 - 2
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``

+ 2 - 2
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.
@@ -10399,7 +10399,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.::