diff options
author | Trevor Woerner <twoerner@gmail.com> | 2025-05-23 21:49:02 -0400 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2025-06-02 10:26:30 -0700 |
commit | e27ee8c2680d85eb8fbb016fa38714e1d2bc8691 (patch) | |
tree | fad790dbad7a63489241e0dd49225a005b8ebdf4 /documentation/kernel-dev | |
parent | 89da6e7a4a75536697fa9b5a7b3c9682fc802325 (diff) | |
download | poky-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/kernel-dev')
-rw-r--r-- | documentation/kernel-dev/common.rst | 14 | ||||
-rw-r--r-- | documentation/kernel-dev/intro.rst | 2 |
2 files changed, 8 insertions, 8 deletions
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 28ef3b22c3..654c4e0a01 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst | |||
@@ -672,7 +672,7 @@ The steps in this procedure show you how you can patch the kernel using | |||
672 | 672 | ||
673 | Before attempting this procedure, be sure you have performed the | 673 | Before attempting this procedure, be sure you have performed the |
674 | steps to get ready for updating the kernel as described in the | 674 | steps to get ready for updating the kernel as described in the |
675 | ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" | 675 | ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" |
676 | section. | 676 | section. |
677 | 677 | ||
678 | Patching the kernel involves changing or adding configurations to an | 678 | Patching the kernel involves changing or adding configurations to an |
@@ -685,7 +685,7 @@ output at boot time through ``printk`` statements in the kernel's | |||
685 | ``calibrate.c`` source code file. Applying the patch and booting the | 685 | ``calibrate.c`` source code file. Applying the patch and booting the |
686 | modified image causes the added messages to appear on the emulator's | 686 | modified image causes the added messages to appear on the emulator's |
687 | console. The example is a continuation of the setup procedure found in | 687 | console. The example is a continuation of the setup procedure found in |
688 | the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Section. | 688 | the ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" Section. |
689 | 689 | ||
690 | #. *Check Out the Kernel Source Files:* First you must use ``devtool`` | 690 | #. *Check Out the Kernel Source Files:* First you must use ``devtool`` |
691 | to checkout the kernel source code in its workspace. | 691 | to checkout the kernel source code in its workspace. |
@@ -693,7 +693,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se | |||
693 | .. note:: | 693 | .. note:: |
694 | 694 | ||
695 | See this step in the | 695 | See this step in the |
696 | ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" | 696 | ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" |
697 | section for more information. | 697 | section for more information. |
698 | 698 | ||
699 | Use the following ``devtool`` command to check out the code:: | 699 | Use the following ``devtool`` command to check out the code:: |
@@ -804,7 +804,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se | |||
804 | .. note:: | 804 | .. note:: |
805 | 805 | ||
806 | See Step 3 of the | 806 | See Step 3 of the |
807 | ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" | 807 | ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" |
808 | section for information on setting up this layer. | 808 | section for information on setting up this layer. |
809 | 809 | ||
810 | Once the command | 810 | Once the command |
@@ -1190,7 +1190,7 @@ appear in the ``.config`` file, which is in the :term:`Build Directory`. | |||
1190 | 1190 | ||
1191 | For more information about where the ``.config`` file is located, see the | 1191 | For more information about where the ``.config`` file is located, see the |
1192 | example in the | 1192 | example in the |
1193 | ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" | 1193 | ":ref:`kernel-dev/common:using ``menuconfig```" |
1194 | section. | 1194 | section. |
1195 | 1195 | ||
1196 | It is simple to create a configuration fragment. One method is to use | 1196 | It is simple to create a configuration fragment. One method is to use |
@@ -1286,7 +1286,7 @@ when you override a policy configuration in a hardware configuration | |||
1286 | fragment. | 1286 | fragment. |
1287 | 1287 | ||
1288 | In order to run this task, you must have an existing ``.config`` file. | 1288 | In order to run this task, you must have an existing ``.config`` file. |
1289 | See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for | 1289 | See the ":ref:`kernel-dev/common:using ``menuconfig```" section for |
1290 | information on how to create a configuration file. | 1290 | information on how to create a configuration file. |
1291 | 1291 | ||
1292 | Here is sample output from the :ref:`ref-tasks-kernel_configcheck` task: | 1292 | Here is sample output from the :ref:`ref-tasks-kernel_configcheck` task: |
@@ -1359,7 +1359,7 @@ and | |||
1359 | tasks until they produce no warnings. | 1359 | tasks until they produce no warnings. |
1360 | 1360 | ||
1361 | For more information on how to use the ``menuconfig`` tool, see the | 1361 | For more information on how to use the ``menuconfig`` tool, see the |
1362 | :ref:`kernel-dev/common:using \`\`menuconfig\`\`` section. | 1362 | :ref:`kernel-dev/common:using ``menuconfig``` section. |
1363 | 1363 | ||
1364 | Fine-Tuning the Kernel Configuration File | 1364 | Fine-Tuning the Kernel Configuration File |
1365 | ----------------------------------------- | 1365 | ----------------------------------------- |
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index a663733a1d..7df342f8d5 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`` requires that you have a clean build | 122 | Using ``devtool`` requires that you have a clean build |
123 | of the image. For | 123 | of the image. 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 |