From 01e5d22507e57c66452f14610ee8eb3d66ac9d71 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Thu, 8 Dec 2022 10:25:59 +0100 Subject: manuals: fix double colons Fixing double colons appearing alone on a line, while they could be put at the end of the previous line. Sometimes placing a note after the quoted text to avoid such a situation. It's more natural too not to have a note between the introduction text and the quoted section. (From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/kernel-dev/advanced.rst | 15 +++++------- documentation/kernel-dev/common.rst | 43 ++++++++++++++--------------------- 2 files changed, 23 insertions(+), 35 deletions(-) (limited to 'documentation/kernel-dev') diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst index b16b3e0517..a8734900a0 100644 --- a/documentation/kernel-dev/advanced.rst +++ b/documentation/kernel-dev/advanced.rst @@ -566,15 +566,7 @@ Example Many real-world examples are more complex. Like any other ``.scc`` file, BSP descriptions can aggregate features. Consider the Minnow BSP definition given the ``linux-yocto-4.4`` branch of the -``yocto-kernel-cache`` (i.e. -``yocto-kernel-cache/bsp/minnow/minnow.scc``): - -.. note:: - - Although the Minnow Board BSP is unused, the Metadata remains and is - being used here just as an example. - -:: +``yocto-kernel-cache`` (i.e. ``yocto-kernel-cache/bsp/minnow/minnow.scc``):: include cfg/x86.scc include features/eg20t/eg20t.scc @@ -597,6 +589,11 @@ definition given the ``linux-yocto-4.4`` branch of the kconf hardware minnow.cfg kconf hardware minnow-dev.cfg +.. note:: + + Although the Minnow Board BSP is unused, the Metadata remains and is + being used here just as an example. + The ``minnow.scc`` description file includes a hardware configuration fragment (``minnow.cfg``) specific to the Minnow BSP as well as several more general configuration fragments and features enabling hardware diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index e9660dd4e6..c4c1f629a6 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -166,8 +166,7 @@ section: checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If you need to checkout out the &DISTRO_NAME; branch, see the ":ref:`dev-manual/start:checking out by branch in poky`" - section in the Yocto Project Development Tasks Manual. - :: + section in the Yocto Project Development Tasks Manual:: $ cd poky $ git branch @@ -244,16 +243,7 @@ section: ``standard/base`` branch. The following commands show how to create a local copy of the - ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch. - - .. note:: - - The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4 - release and forward. - You cannot use the ``linux-yocto-4.12`` kernel with releases prior to - Yocto Project 2.4. - - :: + ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch:: $ cd ~ $ git clone git://git.yoctoproject.org/linux-yocto-4.12 --branch standard/base @@ -265,6 +255,13 @@ section: Resolving deltas: 100% (5152604/5152604), done. Checking connectivity... done. Checking out files: 100% (59846/59846), done. + .. note:: + + The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4 + release and forward. + You cannot use the ``linux-yocto-4.12`` kernel with releases prior to + Yocto Project 2.4. + 6. *Create a Local Copy of the Kernel Cache Git Repository:* For simplicity, it is recommended that you create your copy of the kernel cache Git repository outside of the @@ -428,8 +425,7 @@ As an example, consider the following append file used by the BSPs in Here are the contents of this file. Be aware that the actual commit ID strings in this example listing might be different than the actual -strings in the file from the ``meta-yocto-bsp`` layer upstream. -:: +strings in the file from the ``meta-yocto-bsp`` layer upstream:: KBRANCH:genericx86 = "standard/base" KBRANCH:genericx86-64 = "standard/base" @@ -490,8 +486,7 @@ For example, suppose you had some configuration options in a file called ``network_configs.cfg``. You can place that file inside a directory named ``linux-yocto`` and then add a :term:`SRC_URI` statement such as the following to the append file. When the OpenEmbedded build system builds -the kernel, the configuration options are picked up and applied. -:: +the kernel, the configuration options are picked up and applied:: SRC_URI += "file://network_configs.cfg" @@ -766,7 +761,10 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se 4. *Create the Image With the New Kernel:* Use the ``devtool build-image`` command to create a new image that has the - new kernel. + new kernel:: + + $ cd ~ + $ devtool build-image core-image-minimal .. note:: @@ -776,11 +774,6 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk ` Wiki Page. - :: - - $ cd ~ - $ devtool build-image core-image-minimal - 5. *Test the New Image:* For this example, you can run the new image using QEMU to verify your changes: @@ -812,8 +805,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se 7. *Export the Patches and Create an Append File:* To export your commits as patches and create a ``.bbappend`` file, use the following - command. This example uses the previously established layer named ``meta-mylayer``. - :: + command. This example uses the previously established layer named ``meta-mylayer``:: $ devtool finish linux-yocto ~/meta-mylayer @@ -1760,8 +1752,7 @@ Here is an example that looks at what has changed in the ``emenlow`` branch of the ``linux-yocto-3.19`` kernel. The lower commit range is the commit associated with the ``standard/base`` branch, while the upper commit range is the commit associated with the ``standard/emenlow`` -branch. -:: +branch:: $ git whatchanged origin/standard/base..origin/standard/emenlow -- cgit v1.2.3-54-g00ecf