summaryrefslogtreecommitdiffstats
path: root/documentation
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
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')
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst2
-rw-r--r--documentation/bsp-guide/bsp.rst4
-rw-r--r--documentation/dev-manual/debugging.rst2
-rw-r--r--documentation/dev-manual/new-recipe.rst2
-rw-r--r--documentation/dev-manual/upgrading-recipes.rst2
-rw-r--r--documentation/dev-manual/wic.rst2
-rw-r--r--documentation/kernel-dev/common.rst14
-rw-r--r--documentation/kernel-dev/intro.rst2
-rw-r--r--documentation/overview-manual/concepts.rst2
-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
-rw-r--r--documentation/toaster-manual/reference.rst6
15 files changed, 27 insertions, 27 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index d7e8c6c51b..392d9638aa 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -182,7 +182,7 @@ an entire Linux distribution, including the toolchain, from source.
182 page of the Yocto Project Wiki. 182 page of the Yocto Project Wiki.
183 183
184#. **Initialize the Build Environment:** From within the ``poky`` 184#. **Initialize the Build Environment:** From within the ``poky``
185 directory, run the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` 185 directory, run the :ref:`ref-manual/structure:``oe-init-build-env```
186 environment 186 environment
187 setup script to define Yocto Project's build environment on your 187 setup script to define Yocto Project's build environment on your
188 build host. 188 build host.
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index b5f00d617e..47e4193f38 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -81,7 +81,7 @@ directory of that Layer. This directory is what you add to the
81``conf/bblayers.conf`` file found in your 81``conf/bblayers.conf`` file found in your
82:term:`Build Directory`, which is 82:term:`Build Directory`, which is
83established after you run the OpenEmbedded build environment setup 83established after you run the OpenEmbedded build environment setup
84script (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). 84script (i.e. :ref:`ref-manual/structure:``oe-init-build-env```).
85Adding the root directory allows the :term:`OpenEmbedded Build System` 85Adding the root directory allows the :term:`OpenEmbedded Build System`
86to recognize the BSP 86to recognize the BSP
87layer and from it build an image. Here is an example:: 87layer and from it build an image. Here is an example::
@@ -230,7 +230,7 @@ section.
230 230
231#. *Initialize the Build Environment:* While in the root directory of 231#. *Initialize the Build Environment:* While in the root directory of
232 the Source Directory (i.e. ``poky``), run the 232 the Source Directory (i.e. ``poky``), run the
233 :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment 233 :ref:`ref-manual/structure:``oe-init-build-env``` environment
234 setup script to define the OpenEmbedded build environment on your 234 setup script to define the OpenEmbedded build environment on your
235 build host. :: 235 build host. ::
236 236
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index 74f5772554..5a3fb11170 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -36,7 +36,7 @@ section:
36 use the BitBake ``-e`` option to examine variable values after a 36 use the BitBake ``-e`` option to examine variable values after a
37 recipe has been parsed. 37 recipe has been parsed.
38 38
39- ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" 39- ":ref:`dev-manual/debugging:viewing package information with ``oe-pkgdata-util```"
40 describes how to use the ``oe-pkgdata-util`` utility to query 40 describes how to use the ``oe-pkgdata-util`` utility to query
41 :term:`PKGDATA_DIR` and 41 :term:`PKGDATA_DIR` and
42 display package-related information for built packages. 42 display package-related information for built packages.
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index be52610621..b7385c2ec3 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -56,7 +56,7 @@ necessary when adding a recipe to build a new piece of software to be
56included in a build. 56included in a build.
57 57
58You can find a complete description of the ``devtool add`` command in 58You can find a complete description of the ``devtool add`` command in
59the ":ref:`sdk-manual/extensible:a closer look at \`\`devtool add\`\``" section 59the ":ref:`sdk-manual/extensible:a closer look at ``devtool add```" section
60in the Yocto Project Application Development and the Extensible Software 60in the Yocto Project Application Development and the Extensible Software
61Development Kit (eSDK) manual. 61Development Kit (eSDK) manual.
62 62
diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst
index 4fac78bdfb..a38fd7837c 100644
--- a/documentation/dev-manual/upgrading-recipes.rst
+++ b/documentation/dev-manual/upgrading-recipes.rst
@@ -333,7 +333,7 @@ Manually Upgrading a Recipe
333 333
334If for some reason you choose not to upgrade recipes using 334If for some reason you choose not to upgrade recipes using
335:ref:`dev-manual/upgrading-recipes:Using the Auto Upgrade Helper (AUH)` or 335:ref:`dev-manual/upgrading-recipes:Using the Auto Upgrade Helper (AUH)` or
336by :ref:`dev-manual/upgrading-recipes:Using \`\`devtool upgrade\`\``, 336by :ref:`dev-manual/upgrading-recipes:Using ``devtool upgrade```,
337you can manually edit the recipe files to upgrade the versions. 337you can manually edit the recipe files to upgrade the versions.
338 338
339.. note:: 339.. note::
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index 049996c39e..6ff018f07f 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -514,7 +514,7 @@ or ::
514 514
515 For more information on how to use the ``bmaptool`` 515 For more information on how to use the ``bmaptool``
516 to flash a device with an image, see the 516 to flash a device with an image, see the
517 ":ref:`dev-manual/bmaptool:flashing images using \`\`bmaptool\`\``" 517 ":ref:`dev-manual/bmaptool:flashing images using ``bmaptool```"
518 section. 518 section.
519 519
520Using a Modified Kickstart File 520Using a Modified Kickstart File
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 815695652b..83fe98bf05 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -746,7 +746,7 @@ the extensible SDK and ``devtool``.
746 746
747 Before attempting this procedure, be sure you have performed the 747 Before attempting this procedure, be sure you have performed the
748 steps to get ready for updating the kernel as described in the 748 steps to get ready for updating the kernel as described in the
749 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" 749 ":ref:`kernel-dev/common:getting ready to develop using ``devtool```"
750 section. 750 section.
751 751
752Patching the kernel involves changing or adding configurations to an 752Patching the kernel involves changing or adding configurations to an
@@ -759,7 +759,7 @@ output at boot time through ``printk`` statements in the kernel's
759``calibrate.c`` source code file. Applying the patch and booting the 759``calibrate.c`` source code file. Applying the patch and booting the
760modified image causes the added messages to appear on the emulator's 760modified image causes the added messages to appear on the emulator's
761console. The example is a continuation of the setup procedure found in 761console. The example is a continuation of the setup procedure found in
762the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Section. 762the ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" Section.
763 763
7641. *Check Out the Kernel Source Files:* First you must use ``devtool`` 7641. *Check Out the Kernel Source Files:* First you must use ``devtool``
765 to checkout the kernel source code in its workspace. Be sure you are 765 to checkout the kernel source code in its workspace. Be sure you are
@@ -768,7 +768,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se
768 .. note:: 768 .. note::
769 769
770 See this step in the 770 See this step in the
771 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" 771 ":ref:`kernel-dev/common:getting ready to develop using ``devtool```"
772 section for more information. 772 section for more information.
773 773
774 Use the following ``devtool`` command to check out the code:: 774 Use the following ``devtool`` command to check out the code::
@@ -883,7 +883,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se
883 .. note:: 883 .. note::
884 884
885 See Step 3 of the 885 See Step 3 of the
886 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" 886 ":ref:`kernel-dev/common:getting ready to develop using ``devtool```"
887 section for information on setting up this layer. 887 section for information on setting up this layer.
888 888
889 Once the command 889 Once the command
@@ -1271,7 +1271,7 @@ appear in the ``.config`` file, which is in the :term:`Build Directory`.
1271 1271
1272 For more information about where the ``.config`` file is located, see the 1272 For more information about where the ``.config`` file is located, see the
1273 example in the 1273 example in the
1274 ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" 1274 ":ref:`kernel-dev/common:using ``menuconfig```"
1275 section. 1275 section.
1276 1276
1277It is simple to create a configuration fragment. One method is to use 1277It is simple to create a configuration fragment. One method is to use
@@ -1367,7 +1367,7 @@ when you override a policy configuration in a hardware configuration
1367fragment. 1367fragment.
1368 1368
1369In order to run this task, you must have an existing ``.config`` file. 1369In order to run this task, you must have an existing ``.config`` file.
1370See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for 1370See the ":ref:`kernel-dev/common:using ``menuconfig```" section for
1371information on how to create a configuration file. 1371information on how to create a configuration file.
1372 1372
1373Here is sample output from the ``do_kernel_configcheck`` task: 1373Here is sample output from the ``do_kernel_configcheck`` task:
@@ -1440,7 +1440,7 @@ and
1440tasks until they produce no warnings. 1440tasks until they produce no warnings.
1441 1441
1442For more information on how to use the ``menuconfig`` tool, see the 1442For more information on how to use the ``menuconfig`` tool, see the
1443:ref:`kernel-dev/common:using \`\`menuconfig\`\`` section. 1443:ref:`kernel-dev/common:using ``menuconfig``` section.
1444 1444
1445Fine-Tuning the Kernel Configuration File 1445Fine-Tuning the Kernel Configuration File
1446----------------------------------------- 1446-----------------------------------------
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst
index cc879db887..fea876cbe1 100644
--- a/documentation/kernel-dev/intro.rst
+++ b/documentation/kernel-dev/intro.rst
@@ -122,7 +122,7 @@ general information and references for further information.
122 Using ``devtool`` and the eSDK requires that you have a clean build 122 Using ``devtool`` and the eSDK requires that you have a clean build
123 of the image and that you are set up with the appropriate eSDK. For 123 of the image and that you are set up with the appropriate eSDK. For
124 more information, see the 124 more information, see the
125 ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" 125 ":ref:`kernel-dev/common:getting ready to develop using ``devtool```"
126 section. 126 section.
127 127
128 Using traditional kernel development requires that you have the 128 Using traditional kernel development requires that you have the
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index c7e062bdfb..22ec460014 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -983,7 +983,7 @@ package.
983 983
984 For more information on the ``oe-pkgdata-util`` utility, see the section 984 For more information on the ``oe-pkgdata-util`` utility, see the section
985 :ref:`dev-manual/debugging:Viewing Package Information with 985 :ref:`dev-manual/debugging:Viewing Package Information with
986 \`\`oe-pkgdata-util\`\`` of the Yocto Project Development Tasks Manual. 986 ``oe-pkgdata-util``` of the Yocto Project Development Tasks Manual.
987 987
988To add a custom package variant of the ``${PN}`` recipe named 988To add a custom package variant of the ``${PN}`` recipe named
989``${PN}-extra`` (name is arbitrary), one can add it to the 989``${PN}-extra`` (name is arbitrary), one can add it to the
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`.
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index 927699d2a8..78e0767f58 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -548,7 +548,7 @@ database.
548 548
549You need to run the ``buildslist`` command first to identify existing 549You need to run the ``buildslist`` command first to identify existing
550builds in the database before using the 550builds in the database before using the
551:ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an 551:ref:`toaster-manual/reference:``builddelete``` command. Here is an
552example that assumes default repository and build directory names: 552example that assumes default repository and build directory names:
553 553
554.. code-block:: shell 554.. code-block:: shell
@@ -557,7 +557,7 @@ example that assumes default repository and build directory names:
557 $ python ../bitbake/lib/toaster/manage.py buildslist 557 $ python ../bitbake/lib/toaster/manage.py buildslist
558 558
559If your Toaster database had only one build, the above 559If your Toaster database had only one build, the above
560:ref:`toaster-manual/reference:\`\`buildslist\`\`` 560:ref:`toaster-manual/reference:``buildslist```
561command would return something like the following:: 561command would return something like the following::
562 562
563 1: qemux86 poky core-image-minimal 563 1: qemux86 poky core-image-minimal
@@ -578,7 +578,7 @@ the database.
578 578
579Prior to running the ``builddelete`` command, you need to get the ID 579Prior to running the ``builddelete`` command, you need to get the ID
580associated with builds by using the 580associated with builds by using the
581:ref:`toaster-manual/reference:\`\`buildslist\`\`` command. 581:ref:`toaster-manual/reference:``buildslist``` command.
582 582
583``perf`` 583``perf``
584-------- 584--------