From e27ee8c2680d85eb8fbb016fa38714e1d2bc8691 Mon Sep 17 00:00:00 2001 From: Trevor Woerner Date: Fri, 23 May 2025 21:49:02 -0400 Subject: 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 a heading which contain literals enclosed in double-back-tics; especially in the cases where a heading either contains multiple literals or when the literal is not at the end of the heading. Not all of them can be "fixed" to pass both building and linting. (From yocto-docs rev: 73f4a3e3efce8c4e43939e5053f128faae5b41b1) Signed-off-by: Trevor Woerner Signed-off-by: Antonin Godard (cherry picked from commit 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/ref-manual/devtool-reference.rst | 2 +- documentation/ref-manual/structure.rst | 2 +- documentation/ref-manual/tasks.rst | 4 ++-- documentation/ref-manual/terms.rst | 2 +- documentation/ref-manual/variables.rst | 8 ++++---- 5 files changed, 9 insertions(+), 9 deletions(-) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index e173720e1a..5ac567591c 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 ":ref:`dev-manual/devtool:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. You can also see an example of -how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using \`\`devtool upgrade\`\``" +how to use ``devtool upgrade`` in the ":ref:`dev-manual/upgrading-recipes:using ``devtool upgrade```" section in the Yocto Project Development Tasks Manual. .. _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 directory contain information about each output package produced by the OpenEmbedded build system, and are used in different ways by the build system such as ":ref:`dev-manual/debugging:viewing package information with -\`\`oe-pkgdata-util\`\``". +``oe-pkgdata-util```". .. _structure-build-tmp-sstate-control: diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index d2e1f4ce14..d85d1151f0 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -726,7 +726,7 @@ tool, which you then use to modify the kernel configuration. $ bitbake linux-yocto -c menuconfig -See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" +See the ":ref:`kernel-dev/common:using ``menuconfig```" section in the Yocto Project Linux Kernel Development Manual for more information on this configuration tool. @@ -750,7 +750,7 @@ which can then be applied by subsequent tasks such as Runs ``make menuconfig`` for the kernel. For information on ``menuconfig``, see the -":ref:`kernel-dev/common:using \`\`menuconfig\`\``" +":ref:`kernel-dev/common:using ``menuconfig```" section in the Yocto Project Linux Kernel Development Manual. .. _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: This term refers to the area used by the OpenEmbedded build system for builds. The area is created when you ``source`` the setup environment script that is found in the Source Directory - (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The + (i.e. :ref:`ref-manual/structure:``oe-init-build-env```). The :term:`TOPDIR` variable points to the :term:`Build Directory`. 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 00ab881011..6b4acd2244 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2243,7 +2243,7 @@ system and gives an overview of their function and contents. resides within the :term:`Build Directory` as ``${TMPDIR}/deploy``. For more information on the structure of the Build Directory, see - ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. + ":ref:`ref-manual/structure:the build directory --- ``build/```" section. For more detail on the contents of the ``deploy`` directory, see the ":ref:`overview-manual/concepts:images`", ":ref:`overview-manual/concepts:package feeds`", and @@ -2285,7 +2285,7 @@ system and gives an overview of their function and contents. contents of :term:`IMGDEPLOYDIR` by the :ref:`ref-classes-image` class. For more information on the structure of the :term:`Build Directory`, see - ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. + ":ref:`ref-manual/structure:the build directory --- ``build/```" section. For more detail on the contents of the ``deploy`` directory, see the ":ref:`overview-manual/concepts:images`" and ":ref:`overview-manual/concepts:application development sdk`" sections both in @@ -7084,7 +7084,7 @@ system and gives an overview of their function and contents. For examples of how this data is used, see the ":ref:`overview-manual/concepts:automatically added runtime dependencies`" section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" + ":ref:`dev-manual/debugging:viewing package information with ``oe-pkgdata-util```" section in the Yocto Project Development Tasks Manual. For more information on the shared, global-state directory, see :term:`STAGING_DIR_HOST`. @@ -7138,7 +7138,7 @@ system and gives an overview of their function and contents. the package is built, the version information can be retrieved with ``oe-pkgdata-util package-info ``. See the :ref:`dev-manual/debugging:Viewing Package Information with - \`\`oe-pkgdata-util\`\`` section of the Yocto Project Development Tasks + ``oe-pkgdata-util``` section of the Yocto Project Development Tasks Manual for more information on ``oe-pkgdata-util``. -- cgit v1.2.3-54-g00ecf