summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorTrevor Woerner <twoerner@gmail.com>2025-05-23 21:10:32 -0400
committerSteve Sakoman <steve@sakoman.com>2025-05-27 09:38:57 -0700
commita2f2212436ab85f067e17a024147794dc8c8df47 (patch)
tree9796f9c009a3a539264a9d39bae721de35b5dd3a /documentation/ref-manual
parent3d3c34d4c452313d5356d7912027a36854222f46 (diff)
downloadpoky-a2f2212436ab85f067e17a024147794dc8c8df47.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: 0ba5429953dfa0cdc983ed13ddd06351116031c7) 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.rst8
5 files changed, 9 insertions, 9 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index a6ea00c210..2db2adde95 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -435,7 +435,7 @@ You can read more on the ``devtool upgrade`` workflow in the
435":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" 435":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`"
436section in the Yocto Project Application Development and the Extensible 436section in the Yocto Project Application Development and the Extensible
437Software Development Kit (eSDK) manual. You can also see an example of 437Software Development Kit (eSDK) manual. You can also see an example of
438how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using \`\`devtool upgrade\`\``" 438how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using ``devtool upgrade```"
439section in the Yocto Project Development Tasks Manual. 439section in the Yocto Project Development Tasks Manual.
440 440
441.. _devtool-resetting-a-recipe: 441.. _devtool-resetting-a-recipe:
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 616c3c4c9b..2190f5b90e 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -515,7 +515,7 @@ generated during the :ref:`ref-tasks-packagedata` task. The files stored in this
515directory contain information about each output package produced by the 515directory contain information about each output package produced by the
516OpenEmbedded build system, and are used in different ways by the build system 516OpenEmbedded build system, and are used in different ways by the build system
517such as ":ref:`dev-manual/debugging:viewing package information with 517such as ":ref:`dev-manual/debugging:viewing package information with
518\`\`oe-pkgdata-util\`\``". 518``oe-pkgdata-util```".
519 519
520.. _structure-build-tmp-sstate-control: 520.. _structure-build-tmp-sstate-control:
521 521
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 5cd23449fa..cf6b9876ca 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -727,7 +727,7 @@ tool, which you then use to modify the kernel configuration.
727 $ bitbake linux-yocto -c menuconfig 727 $ bitbake linux-yocto -c menuconfig
728 728
729 729
730See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" 730See the ":ref:`kernel-dev/common:using ``menuconfig```"
731section in the Yocto Project Linux Kernel Development Manual for more 731section in the Yocto Project Linux Kernel Development Manual for more
732information on this configuration tool. 732information on this configuration tool.
733 733
@@ -751,7 +751,7 @@ which can then be applied by subsequent tasks such as
751 751
752Runs ``make menuconfig`` for the kernel. For information on 752Runs ``make menuconfig`` for the kernel. For information on
753``menuconfig``, see the 753``menuconfig``, see the
754":ref:`kernel-dev/common:using \`\`menuconfig\`\``" 754":ref:`kernel-dev/common:using ``menuconfig```"
755section in the Yocto Project Linux Kernel Development Manual. 755section in the Yocto Project Linux Kernel Development Manual.
756 756
757.. _ref-tasks-savedefconfig: 757.. _ref-tasks-savedefconfig:
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 9d765c89c8..9f61061415 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 :term:`Build Directory`. 67 :term:`TOPDIR` variable points to the :term:`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 20dc7f0950..e43dc38f32 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2199,7 +2199,7 @@ system and gives an overview of their function and contents.
2199 resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``. 2199 resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``.
2200 2200
2201 For more information on the structure of the Build Directory, see 2201 For more information on the structure of the Build Directory, see
2202 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 2202 ":ref:`ref-manual/structure:the build directory --- ``build/```" section.
2203 For more detail on the contents of the ``deploy`` directory, see the 2203 For more detail on the contents of the ``deploy`` directory, see the
2204 ":ref:`overview-manual/concepts:images`", 2204 ":ref:`overview-manual/concepts:images`",
2205 ":ref:`overview-manual/concepts:package feeds`", and 2205 ":ref:`overview-manual/concepts:package feeds`", and
@@ -2241,7 +2241,7 @@ system and gives an overview of their function and contents.
2241 contents of :term:`IMGDEPLOYDIR` by the :ref:`ref-classes-image` class. 2241 contents of :term:`IMGDEPLOYDIR` by the :ref:`ref-classes-image` class.
2242 2242
2243 For more information on the structure of the :term:`Build Directory`, see 2243 For more information on the structure of the :term:`Build Directory`, see
2244 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 2244 ":ref:`ref-manual/structure:the build directory --- ``build/```" section.
2245 For more detail on the contents of the ``deploy`` directory, see the 2245 For more detail on the contents of the ``deploy`` directory, see the
2246 ":ref:`overview-manual/concepts:images`" and 2246 ":ref:`overview-manual/concepts:images`" and
2247 ":ref:`overview-manual/concepts:application development sdk`" sections both in 2247 ":ref:`overview-manual/concepts:application development sdk`" sections both in
@@ -6730,7 +6730,7 @@ system and gives an overview of their function and contents.
6730 For examples of how this data is used, see the 6730 For examples of how this data is used, see the
6731 ":ref:`overview-manual/concepts:automatically added runtime dependencies`" 6731 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
6732 section in the Yocto Project Overview and Concepts Manual and the 6732 section in the Yocto Project Overview and Concepts Manual and the
6733 ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" 6733 ":ref:`dev-manual/debugging:viewing package information with ``oe-pkgdata-util```"
6734 section in the Yocto Project Development Tasks Manual. For more 6734 section in the Yocto Project Development Tasks Manual. For more
6735 information on the shared, global-state directory, see 6735 information on the shared, global-state directory, see
6736 :term:`STAGING_DIR_HOST`. 6736 :term:`STAGING_DIR_HOST`.
@@ -6784,7 +6784,7 @@ system and gives an overview of their function and contents.
6784 the package is built, the version information can be retrieved with 6784 the package is built, the version information can be retrieved with
6785 ``oe-pkgdata-util package-info <package name>``. See the 6785 ``oe-pkgdata-util package-info <package name>``. See the
6786 :ref:`dev-manual/debugging:Viewing Package Information with 6786 :ref:`dev-manual/debugging:Viewing Package Information with
6787 \`\`oe-pkgdata-util\`\`` section of the Yocto Project Development Tasks 6787 ``oe-pkgdata-util``` section of the Yocto Project Development Tasks
6788 Manual for more information on ``oe-pkgdata-util``. 6788 Manual for more information on ``oe-pkgdata-util``.
6789 6789
6790 6790