diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-08 10:25:59 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-18 10:41:21 +0000 |
commit | 01e5d22507e57c66452f14610ee8eb3d66ac9d71 (patch) | |
tree | 7241fa93a3a0d11db32d042e5d70a750132ab0a1 /documentation/kernel-dev | |
parent | 8b812b29c4b13ba028c0d66f73a6599a988486d5 (diff) | |
download | poky-01e5d22507e57c66452f14610ee8eb3d66ac9d71.tar.gz |
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 <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r-- | documentation/kernel-dev/advanced.rst | 15 | ||||
-rw-r--r-- | documentation/kernel-dev/common.rst | 43 |
2 files changed, 23 insertions, 35 deletions
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 | |||
566 | Many real-world examples are more complex. Like any other ``.scc`` file, | 566 | Many real-world examples are more complex. Like any other ``.scc`` file, |
567 | BSP descriptions can aggregate features. Consider the Minnow BSP | 567 | BSP descriptions can aggregate features. Consider the Minnow BSP |
568 | definition given the ``linux-yocto-4.4`` branch of the | 568 | definition given the ``linux-yocto-4.4`` branch of the |
569 | ``yocto-kernel-cache`` (i.e. | 569 | ``yocto-kernel-cache`` (i.e. ``yocto-kernel-cache/bsp/minnow/minnow.scc``):: |
570 | ``yocto-kernel-cache/bsp/minnow/minnow.scc``): | ||
571 | |||
572 | .. note:: | ||
573 | |||
574 | Although the Minnow Board BSP is unused, the Metadata remains and is | ||
575 | being used here just as an example. | ||
576 | |||
577 | :: | ||
578 | 570 | ||
579 | include cfg/x86.scc | 571 | include cfg/x86.scc |
580 | include features/eg20t/eg20t.scc | 572 | include features/eg20t/eg20t.scc |
@@ -597,6 +589,11 @@ definition given the ``linux-yocto-4.4`` branch of the | |||
597 | kconf hardware minnow.cfg | 589 | kconf hardware minnow.cfg |
598 | kconf hardware minnow-dev.cfg | 590 | kconf hardware minnow-dev.cfg |
599 | 591 | ||
592 | .. note:: | ||
593 | |||
594 | Although the Minnow Board BSP is unused, the Metadata remains and is | ||
595 | being used here just as an example. | ||
596 | |||
600 | The ``minnow.scc`` description file includes a hardware configuration | 597 | The ``minnow.scc`` description file includes a hardware configuration |
601 | fragment (``minnow.cfg``) specific to the Minnow BSP as well as several | 598 | fragment (``minnow.cfg``) specific to the Minnow BSP as well as several |
602 | more general configuration fragments and features enabling hardware | 599 | 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: | |||
166 | checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If | 166 | checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If |
167 | you need to checkout out the &DISTRO_NAME; branch, see the | 167 | you need to checkout out the &DISTRO_NAME; branch, see the |
168 | ":ref:`dev-manual/start:checking out by branch in poky`" | 168 | ":ref:`dev-manual/start:checking out by branch in poky`" |
169 | section in the Yocto Project Development Tasks Manual. | 169 | section in the Yocto Project Development Tasks Manual:: |
170 | :: | ||
171 | 170 | ||
172 | $ cd poky | 171 | $ cd poky |
173 | $ git branch | 172 | $ git branch |
@@ -244,16 +243,7 @@ section: | |||
244 | ``standard/base`` branch. | 243 | ``standard/base`` branch. |
245 | 244 | ||
246 | The following commands show how to create a local copy of the | 245 | The following commands show how to create a local copy of the |
247 | ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch. | 246 | ``linux-yocto-4.12`` kernel and be in the ``standard/base`` branch:: |
248 | |||
249 | .. note:: | ||
250 | |||
251 | The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4 | ||
252 | release and forward. | ||
253 | You cannot use the ``linux-yocto-4.12`` kernel with releases prior to | ||
254 | Yocto Project 2.4. | ||
255 | |||
256 | :: | ||
257 | 247 | ||
258 | $ cd ~ | 248 | $ cd ~ |
259 | $ git clone git://git.yoctoproject.org/linux-yocto-4.12 --branch standard/base | 249 | $ git clone git://git.yoctoproject.org/linux-yocto-4.12 --branch standard/base |
@@ -265,6 +255,13 @@ section: | |||
265 | Resolving deltas: 100% (5152604/5152604), done. Checking connectivity... done. | 255 | Resolving deltas: 100% (5152604/5152604), done. Checking connectivity... done. |
266 | Checking out files: 100% (59846/59846), done. | 256 | Checking out files: 100% (59846/59846), done. |
267 | 257 | ||
258 | .. note:: | ||
259 | |||
260 | The ``linux-yocto-4.12`` kernel can be used with the Yocto Project 2.4 | ||
261 | release and forward. | ||
262 | You cannot use the ``linux-yocto-4.12`` kernel with releases prior to | ||
263 | Yocto Project 2.4. | ||
264 | |||
268 | 6. *Create a Local Copy of the Kernel Cache Git Repository:* For | 265 | 6. *Create a Local Copy of the Kernel Cache Git Repository:* For |
269 | simplicity, it is recommended that you create your copy of the kernel | 266 | simplicity, it is recommended that you create your copy of the kernel |
270 | cache Git repository outside of the | 267 | cache Git repository outside of the |
@@ -428,8 +425,7 @@ As an example, consider the following append file used by the BSPs in | |||
428 | 425 | ||
429 | Here are the contents of this file. Be aware that the actual commit ID | 426 | Here are the contents of this file. Be aware that the actual commit ID |
430 | strings in this example listing might be different than the actual | 427 | strings in this example listing might be different than the actual |
431 | strings in the file from the ``meta-yocto-bsp`` layer upstream. | 428 | strings in the file from the ``meta-yocto-bsp`` layer upstream:: |
432 | :: | ||
433 | 429 | ||
434 | KBRANCH:genericx86 = "standard/base" | 430 | KBRANCH:genericx86 = "standard/base" |
435 | KBRANCH:genericx86-64 = "standard/base" | 431 | KBRANCH:genericx86-64 = "standard/base" |
@@ -490,8 +486,7 @@ For example, suppose you had some configuration options in a file called | |||
490 | ``network_configs.cfg``. You can place that file inside a directory | 486 | ``network_configs.cfg``. You can place that file inside a directory |
491 | named ``linux-yocto`` and then add a :term:`SRC_URI` statement such as the | 487 | named ``linux-yocto`` and then add a :term:`SRC_URI` statement such as the |
492 | following to the append file. When the OpenEmbedded build system builds | 488 | following to the append file. When the OpenEmbedded build system builds |
493 | the kernel, the configuration options are picked up and applied. | 489 | the kernel, the configuration options are picked up and applied:: |
494 | :: | ||
495 | 490 | ||
496 | SRC_URI += "file://network_configs.cfg" | 491 | SRC_URI += "file://network_configs.cfg" |
497 | 492 | ||
@@ -766,7 +761,10 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se | |||
766 | 761 | ||
767 | 4. *Create the Image With the New Kernel:* Use the | 762 | 4. *Create the Image With the New Kernel:* Use the |
768 | ``devtool build-image`` command to create a new image that has the | 763 | ``devtool build-image`` command to create a new image that has the |
769 | new kernel. | 764 | new kernel:: |
765 | |||
766 | $ cd ~ | ||
767 | $ devtool build-image core-image-minimal | ||
770 | 768 | ||
771 | .. note:: | 769 | .. note:: |
772 | 770 | ||
@@ -776,11 +774,6 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se | |||
776 | :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` | 774 | :yocto_wiki:`TipsAndTricks/KernelDevelopmentWithEsdk </TipsAndTricks/KernelDevelopmentWithEsdk>` |
777 | Wiki Page. | 775 | Wiki Page. |
778 | 776 | ||
779 | :: | ||
780 | |||
781 | $ cd ~ | ||
782 | $ devtool build-image core-image-minimal | ||
783 | |||
784 | 5. *Test the New Image:* For this example, you can run the new image | 777 | 5. *Test the New Image:* For this example, you can run the new image |
785 | using QEMU to verify your changes: | 778 | using QEMU to verify your changes: |
786 | 779 | ||
@@ -812,8 +805,7 @@ the ":ref:`kernel-dev/common:getting ready to develop using \`\`devtool\`\``" Se | |||
812 | 805 | ||
813 | 7. *Export the Patches and Create an Append File:* To export your | 806 | 7. *Export the Patches and Create an Append File:* To export your |
814 | commits as patches and create a ``.bbappend`` file, use the following | 807 | commits as patches and create a ``.bbappend`` file, use the following |
815 | command. This example uses the previously established layer named ``meta-mylayer``. | 808 | command. This example uses the previously established layer named ``meta-mylayer``:: |
816 | :: | ||
817 | 809 | ||
818 | $ devtool finish linux-yocto ~/meta-mylayer | 810 | $ devtool finish linux-yocto ~/meta-mylayer |
819 | 811 | ||
@@ -1760,8 +1752,7 @@ Here is an example that looks at what has changed in the ``emenlow`` | |||
1760 | branch of the ``linux-yocto-3.19`` kernel. The lower commit range is the | 1752 | branch of the ``linux-yocto-3.19`` kernel. The lower commit range is the |
1761 | commit associated with the ``standard/base`` branch, while the upper | 1753 | commit associated with the ``standard/base`` branch, while the upper |
1762 | commit range is the commit associated with the ``standard/emenlow`` | 1754 | commit range is the commit associated with the ``standard/emenlow`` |
1763 | branch. | 1755 | branch:: |
1764 | :: | ||
1765 | 1756 | ||
1766 | $ git whatchanged origin/standard/base..origin/standard/emenlow | 1757 | $ git whatchanged origin/standard/base..origin/standard/emenlow |
1767 | 1758 | ||