summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorTrevor Woerner <twoerner@gmail.com>2025-05-24 16:06:30 -0400
committerSteve Sakoman <steve@sakoman.com>2025-05-28 08:46:32 -0700
commit7dfd7de94185a04eb20e40a6000298e2eba5163a (patch)
tree007751889590651397aa639ac9abf1c3d4ed6b23 /documentation/ref-manual
parentd2de20a4b6f5573cb90b054394cdf4f53d58e95f (diff)
downloadpoky-7dfd7de94185a04eb20e40a6000298e2eba5163a.tar.gz
sphinx-lint: unbalanced inline literal markup
Fix as many instances of unbalanced-inline-literals-delimiters as reported by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get tripped up randomly when references contain links to heading which contain literals enclosed in double-back-tics, and not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 2c1e5b080ad5e62d8283d332cbc473fd2d59c6e6) Signed-off-by: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/devtool-reference.rst2
-rw-r--r--documentation/ref-manual/structure.rst2
-rw-r--r--documentation/ref-manual/tasks.rst4
-rw-r--r--documentation/ref-manual/terms.rst2
-rw-r--r--documentation/ref-manual/variables.rst6
5 files changed, 8 insertions, 8 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index ccf4ab3d13..56070b6218 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -432,7 +432,7 @@ You can read more on the ``devtool upgrade`` workflow in the
432":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" 432":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`"
433section in the Yocto Project Application Development and the Extensible 433section in the Yocto Project Application Development and the Extensible
434Software Development Kit (eSDK) manual. You can also see an example of 434Software Development Kit (eSDK) manual. You can also see an example of
435how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using \`\`devtool upgrade\`\``" 435how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using ``devtool upgrade```"
436section in the Yocto Project Development Tasks Manual. 436section in the Yocto Project Development Tasks Manual.
437 437
438.. _devtool-resetting-a-recipe: 438.. _devtool-resetting-a-recipe:
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 4cf23544db..1bb35da5dc 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -498,7 +498,7 @@ generated during the :ref:`ref-tasks-packagedata` task. The files stored in this
498directory contain information about each output package produced by the 498directory contain information about each output package produced by the
499OpenEmbedded build system, and are used in different ways by the build system 499OpenEmbedded build system, and are used in different ways by the build system
500such as ":ref:`dev-manual/debugging:viewing package information with 500such as ":ref:`dev-manual/debugging:viewing package information with
501\`\`oe-pkgdata-util\`\``". 501``oe-pkgdata-util```".
502 502
503.. _structure-build-tmp-sstate-control: 503.. _structure-build-tmp-sstate-control:
504 504
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index c69fbaa518..563ed0586f 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -740,7 +740,7 @@ tool, which you then use to modify the kernel configuration.
740 $ bitbake linux-yocto -c menuconfig 740 $ bitbake linux-yocto -c menuconfig
741 741
742 742
743See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" 743See the ":ref:`kernel-dev/common:using ``menuconfig```"
744section in the Yocto Project Linux Kernel Development Manual for more 744section in the Yocto Project Linux Kernel Development Manual for more
745information on this configuration tool. 745information on this configuration tool.
746 746
@@ -764,7 +764,7 @@ which can then be applied by subsequent tasks such as
764 764
765Runs ``make menuconfig`` for the kernel. For information on 765Runs ``make menuconfig`` for the kernel. For information on
766``menuconfig``, see the 766``menuconfig``, see the
767":ref:`kernel-dev/common:using \`\`menuconfig\`\``" 767":ref:`kernel-dev/common:using ``menuconfig```"
768section in the Yocto Project Linux Kernel Development Manual. 768section in the Yocto Project Linux Kernel Development Manual.
769 769
770.. _ref-tasks-savedefconfig: 770.. _ref-tasks-savedefconfig:
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 89cbc8ac68..b9cf063ca1 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -63,7 +63,7 @@ universal, the list includes them just in case:
63 This term refers to the area used by the OpenEmbedded build system for 63 This term refers to the area used by the OpenEmbedded build system for
64 builds. The area is created when you ``source`` the setup environment 64 builds. The area is created when you ``source`` the setup environment
65 script that is found in the Source Directory 65 script that is found in the Source Directory
66 (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The 66 (i.e. :ref:`ref-manual/structure:``oe-init-build-env```). The
67 :term:`TOPDIR` variable points to the Build Directory. 67 :term:`TOPDIR` variable points to the Build Directory.
68 68
69 You have a lot of flexibility when creating the :term:`Build Directory`. 69 You have a lot of flexibility when creating the :term:`Build Directory`.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 019285f360..4610add7ea 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1806,7 +1806,7 @@ system and gives an overview of their function and contents.
1806 ``${TMPDIR}/deploy``. 1806 ``${TMPDIR}/deploy``.
1807 1807
1808 For more information on the structure of the Build Directory, see 1808 For more information on the structure of the Build Directory, see
1809 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1809 ":ref:`ref-manual/structure:the build directory --- ``build/```" section.
1810 For more detail on the contents of the ``deploy`` directory, see the 1810 For more detail on the contents of the ``deploy`` directory, see the
1811 ":ref:`overview-manual/concepts:images`", 1811 ":ref:`overview-manual/concepts:images`",
1812 ":ref:`overview-manual/concepts:package feeds`", and 1812 ":ref:`overview-manual/concepts:package feeds`", and
@@ -1850,7 +1850,7 @@ system and gives an overview of their function and contents.
1850 <ref-classes-image>` class. 1850 <ref-classes-image>` class.
1851 1851
1852 For more information on the structure of the Build Directory, see 1852 For more information on the structure of the Build Directory, see
1853 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1853 ":ref:`ref-manual/structure:the build directory --- ``build/```" section.
1854 For more detail on the contents of the ``deploy`` directory, see the 1854 For more detail on the contents of the ``deploy`` directory, see the
1855 ":ref:`overview-manual/concepts:images`" and 1855 ":ref:`overview-manual/concepts:images`" and
1856 ":ref:`overview-manual/concepts:application development sdk`" sections both in 1856 ":ref:`overview-manual/concepts:application development sdk`" sections both in
@@ -6099,7 +6099,7 @@ system and gives an overview of their function and contents.
6099 For examples of how this data is used, see the 6099 For examples of how this data is used, see the
6100 ":ref:`overview-manual/concepts:automatically added runtime dependencies`" 6100 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
6101 section in the Yocto Project Overview and Concepts Manual and the 6101 section in the Yocto Project Overview and Concepts Manual and the
6102 ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" 6102 ":ref:`dev-manual/debugging:viewing package information with ``oe-pkgdata-util```"
6103 section in the Yocto Project Development Tasks Manual. For more 6103 section in the Yocto Project Development Tasks Manual. For more
6104 information on the shared, global-state directory, see 6104 information on the shared, global-state directory, see
6105 :term:`STAGING_DIR_HOST`. 6105 :term:`STAGING_DIR_HOST`.