From 7dfd7de94185a04eb20e40a6000298e2eba5163a Mon Sep 17 00:00:00 2001 From: Trevor Woerner Date: Sat, 24 May 2025 16:06:30 -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 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 Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/kernel-dev/common.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'documentation/kernel-dev/common.rst') 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``. Before attempting this procedure, be sure you have performed the steps to get ready for updating the kernel as described in the - ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" section. Patching the kernel involves changing or adding configurations to an @@ -759,7 +759,7 @@ output at boot time through ``printk`` statements in the kernel's ``calibrate.c`` source code file. Applying the patch and booting the modified image causes the added messages to appear on the emulator's console. The example is a continuation of the setup procedure found in -the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Section. +the ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" Section. 1. *Check Out the Kernel Source Files:* First you must use ``devtool`` 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 .. note:: See this step in the - ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" section for more information. 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 .. note:: See Step 3 of the - ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" + ":ref:`kernel-dev/common:getting ready to develop using ``devtool```" section for information on setting up this layer. Once the command @@ -1271,7 +1271,7 @@ appear in the ``.config`` file, which is in the :term:`Build Directory`. For more information about where the ``.config`` file is located, see the example in the - ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" + ":ref:`kernel-dev/common:using ``menuconfig```" section. It 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 fragment. In order to run this task, you must have an existing ``.config`` file. -See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for +See the ":ref:`kernel-dev/common:using ``menuconfig```" section for information on how to create a configuration file. Here is sample output from the ``do_kernel_configcheck`` task: @@ -1440,7 +1440,7 @@ and tasks until they produce no warnings. For more information on how to use the ``menuconfig`` tool, see the -:ref:`kernel-dev/common:using \`\`menuconfig\`\`` section. +:ref:`kernel-dev/common:using ``menuconfig``` section. Fine-Tuning the Kernel Configuration File ----------------------------------------- -- cgit v1.2.3-54-g00ecf