summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorTrevor Woerner <twoerner@gmail.com>2025-05-23 21:49:02 -0400
committerSteve Sakoman <steve@sakoman.com>2025-06-02 10:26:30 -0700
commite27ee8c2680d85eb8fbb016fa38714e1d2bc8691 (patch)
treefad790dbad7a63489241e0dd49225a005b8ebdf4 /documentation/dev-manual
parent89da6e7a4a75536697fa9b5a7b3c9682fc802325 (diff)
downloadpoky-e27ee8c2680d85eb8fbb016fa38714e1d2bc8691.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 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 <twoerner@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 3460177c46d360b0f2f852cdab23f21bd4ec6d5a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/debugging.rst2
-rw-r--r--documentation/dev-manual/new-recipe.rst2
-rw-r--r--documentation/dev-manual/start.rst2
-rw-r--r--documentation/dev-manual/upgrading-recipes.rst2
4 files changed, 4 insertions, 4 deletions
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index 92458a0c37..8552b26aea 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 4a65d70243..9792bd4c1f 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:`dev-manual/devtool:a closer look at \`\`devtool add\`\``" section 59the ":ref:`dev-manual/devtool: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/start.rst b/documentation/dev-manual/start.rst
index 21d3dce58c..798bca76ef 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -858,7 +858,7 @@ Initializing the Build Environment
858================================== 858==================================
859 859
860Before you can use Yocto you need to setup the build environment. 860Before you can use Yocto you need to setup the build environment.
861From within the ``poky`` directory, source the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment 861From within the ``poky`` directory, source the :ref:`ref-manual/structure:``oe-init-build-env``` environment
862setup script to define Yocto Project's build environment on your build host:: 862setup script to define Yocto Project's build environment on your build host::
863 863
864 $ source oe-init-build-env 864 $ source oe-init-build-env
diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst
index 35901a0ea8..2e65678679 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::