diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-11-24 17:50:52 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-01 19:20:29 +0000 |
commit | 945c669138a76be18c6b4da4f8f907d2a5cfd83f (patch) | |
tree | cebff3cae5021d4fcceb5aa51fce1c2aead97ed2 /documentation/kernel-dev | |
parent | 6fe3143800925463279d0664fc7f3372b53c6c52 (diff) | |
download | poky-945c669138a76be18c6b4da4f8f907d2a5cfd83f.tar.gz |
manuals: split dev-manual/common-tasks.rst
A 500 KB source file is always harder to manage,
and can have section title conflicts.
So, the "Common Tasks" document is gone and all
its constituents are moved up one level.
You now have 40 chapters in the Development Tasks Manual.
(From yocto-docs rev: 8a45bc469411410020b8e688c137395fcaf3761b)
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/common.rst | 16 | ||||
-rw-r--r-- | documentation/kernel-dev/faq.rst | 2 | ||||
-rw-r--r-- | documentation/kernel-dev/intro.rst | 2 |
3 files changed, 10 insertions, 10 deletions
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 028b6af84c..e9660dd4e6 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst | |||
@@ -97,13 +97,13 @@ section: | |||
97 | 97 | ||
98 | For background information on working with common and BSP layers, | 98 | For background information on working with common and BSP layers, |
99 | see the | 99 | see the |
100 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 100 | ":ref:`dev-manual/layers:understanding and creating layers`" |
101 | section in the Yocto Project Development Tasks Manual and the | 101 | section in the Yocto Project Development Tasks Manual and the |
102 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board | 102 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board |
103 | Support (BSP) Developer's Guide, respectively. For information on how to | 103 | Support (BSP) Developer's Guide, respectively. For information on how to |
104 | use the ``bitbake-layers create-layer`` command to quickly set up a layer, | 104 | use the ``bitbake-layers create-layer`` command to quickly set up a layer, |
105 | see the | 105 | see the |
106 | ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 106 | ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" |
107 | section in the Yocto Project Development Tasks Manual. | 107 | section in the Yocto Project Development Tasks Manual. |
108 | 108 | ||
109 | 4. *Inform the BitBake Build Environment About Your Layer:* As directed | 109 | 4. *Inform the BitBake Build Environment About Your Layer:* As directed |
@@ -213,13 +213,13 @@ section: | |||
213 | 213 | ||
214 | For background information on working with common and BSP layers, | 214 | For background information on working with common and BSP layers, |
215 | see the | 215 | see the |
216 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 216 | ":ref:`dev-manual/layers:understanding and creating layers`" |
217 | section in the Yocto Project Development Tasks Manual and the | 217 | section in the Yocto Project Development Tasks Manual and the |
218 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board | 218 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board |
219 | Support (BSP) Developer's Guide, respectively. For information on how to | 219 | Support (BSP) Developer's Guide, respectively. For information on how to |
220 | use the ``bitbake-layers create-layer`` command to quickly set up a layer, | 220 | use the ``bitbake-layers create-layer`` command to quickly set up a layer, |
221 | see the | 221 | see the |
222 | ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 222 | ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" |
223 | section in the Yocto Project Development Tasks Manual. | 223 | section in the Yocto Project Development Tasks Manual. |
224 | 224 | ||
225 | 4. *Inform the BitBake Build Environment About Your Layer:* As directed | 225 | 4. *Inform the BitBake Build Environment About Your Layer:* As directed |
@@ -299,7 +299,7 @@ layer contains its own :term:`BitBake` | |||
299 | append files (``.bbappend``) and provides a convenient mechanism to | 299 | append files (``.bbappend``) and provides a convenient mechanism to |
300 | create your own recipe files (``.bb``) as well as store and use kernel | 300 | create your own recipe files (``.bb``) as well as store and use kernel |
301 | patch files. For background information on working with layers, see the | 301 | patch files. For background information on working with layers, see the |
302 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 302 | ":ref:`dev-manual/layers:understanding and creating layers`" |
303 | section in the Yocto Project Development Tasks Manual. | 303 | section in the Yocto Project Development Tasks Manual. |
304 | 304 | ||
305 | .. note:: | 305 | .. note:: |
@@ -307,7 +307,7 @@ section in the Yocto Project Development Tasks Manual. | |||
307 | The Yocto Project comes with many tools that simplify tasks you need | 307 | The Yocto Project comes with many tools that simplify tasks you need |
308 | to perform. One such tool is the ``bitbake-layers create-layer`` | 308 | to perform. One such tool is the ``bitbake-layers create-layer`` |
309 | command, which simplifies creating a new layer. See the | 309 | command, which simplifies creating a new layer. See the |
310 | ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 310 | ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" |
311 | section in the Yocto Project Development Tasks Manual for | 311 | section in the Yocto Project Development Tasks Manual for |
312 | information on how to use this script to quick set up a new layer. | 312 | information on how to use this script to quick set up a new layer. |
313 | 313 | ||
@@ -360,7 +360,7 @@ home directory: | |||
360 | The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements | 360 | The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements |
361 | enable the OpenEmbedded build system to find patch files. For more | 361 | enable the OpenEmbedded build system to find patch files. For more |
362 | information on using append files, see the | 362 | information on using append files, see the |
363 | ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" | 363 | ":ref:`dev-manual/layers:appending other layers metadata with your layer`" |
364 | section in the Yocto Project Development Tasks Manual. | 364 | section in the Yocto Project Development Tasks Manual. |
365 | 365 | ||
366 | Modifying an Existing Recipe | 366 | Modifying an Existing Recipe |
@@ -1002,7 +1002,7 @@ Section. | |||
1002 | For more information on append files and patches, see the | 1002 | For more information on append files and patches, see the |
1003 | ":ref:`kernel-dev/common:creating the append file`" and | 1003 | ":ref:`kernel-dev/common:creating the append file`" and |
1004 | ":ref:`kernel-dev/common:applying patches`" sections. You can also see the | 1004 | ":ref:`kernel-dev/common:applying patches`" sections. You can also see the |
1005 | ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" | 1005 | ":ref:`dev-manual/layers:appending other layers metadata with your layer`" |
1006 | section in the Yocto Project Development Tasks Manual. | 1006 | section in the Yocto Project Development Tasks Manual. |
1007 | 1007 | ||
1008 | .. note:: | 1008 | .. note:: |
diff --git a/documentation/kernel-dev/faq.rst b/documentation/kernel-dev/faq.rst index e40e3ff372..ceb5dda3f5 100644 --- a/documentation/kernel-dev/faq.rst +++ b/documentation/kernel-dev/faq.rst | |||
@@ -38,7 +38,7 @@ The kernel image (e.g. ``vmlinuz``) is provided by the | |||
38 | specify whether or not the kernel image is installed in the generated | 38 | specify whether or not the kernel image is installed in the generated |
39 | root filesystem, override ``RDEPENDS:${KERNEL_PACKAGE_NAME}-base`` to include or not | 39 | root filesystem, override ``RDEPENDS:${KERNEL_PACKAGE_NAME}-base`` to include or not |
40 | include "kernel-image". See the | 40 | include "kernel-image". See the |
41 | ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" | 41 | ":ref:`dev-manual/layers:appending other layers metadata with your layer`" |
42 | section in the | 42 | section in the |
43 | Yocto Project Development Tasks Manual for information on how to use an | 43 | Yocto Project Development Tasks Manual for information on how to use an |
44 | append file to override metadata. | 44 | append file to override metadata. |
diff --git a/documentation/kernel-dev/intro.rst b/documentation/kernel-dev/intro.rst index 267b7e7797..06cc884386 100644 --- a/documentation/kernel-dev/intro.rst +++ b/documentation/kernel-dev/intro.rst | |||
@@ -87,7 +87,7 @@ understand the following documentation: | |||
87 | as described in the Yocto Project Application Development and the | 87 | as described in the Yocto Project Application Development and the |
88 | Extensible Software Development Kit (eSDK) manual. | 88 | Extensible Software Development Kit (eSDK) manual. |
89 | 89 | ||
90 | - The ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 90 | - The ":ref:`dev-manual/layers:understanding and creating layers`" |
91 | section in the Yocto Project Development Tasks Manual. | 91 | section in the Yocto Project Development Tasks Manual. |
92 | 92 | ||
93 | - The ":ref:`kernel-dev/intro:kernel modification workflow`" section. | 93 | - The ":ref:`kernel-dev/intro:kernel modification workflow`" section. |