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/overview-manual | |
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/overview-manual')
-rw-r--r-- | documentation/overview-manual/concepts.rst | 20 | ||||
-rw-r--r-- | documentation/overview-manual/development-environment.rst | 12 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 10 |
3 files changed, 21 insertions, 21 deletions
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 386a9e09d5..562f460c33 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -34,7 +34,7 @@ itself is of various types: | |||
34 | 34 | ||
35 | BitBake knows how to combine multiple data sources together and refers | 35 | BitBake knows how to combine multiple data sources together and refers |
36 | to each data source as a layer. For information on layers, see the | 36 | to each data source as a layer. For information on layers, see the |
37 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 37 | ":ref:`dev-manual/layers:understanding and creating layers`" |
38 | section of the Yocto Project Development Tasks Manual. | 38 | section of the Yocto Project Development Tasks Manual. |
39 | 39 | ||
40 | Following are some brief details on these core components. For | 40 | Following are some brief details on these core components. For |
@@ -149,7 +149,7 @@ Conforming to a known structure allows BitBake to make assumptions | |||
149 | during builds on where to find types of metadata. You can find | 149 | during builds on where to find types of metadata. You can find |
150 | procedures and learn about tools (i.e. ``bitbake-layers``) for creating | 150 | procedures and learn about tools (i.e. ``bitbake-layers``) for creating |
151 | layers suitable for the Yocto Project in the | 151 | layers suitable for the Yocto Project in the |
152 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 152 | ":ref:`dev-manual/layers:understanding and creating layers`" |
153 | section of the Yocto Project Development Tasks Manual. | 153 | section of the Yocto Project Development Tasks Manual. |
154 | 154 | ||
155 | OpenEmbedded Build System Concepts | 155 | OpenEmbedded Build System Concepts |
@@ -307,7 +307,7 @@ during the build. By default, the layers listed in this file include | |||
307 | layers minimally needed by the build system. However, you must manually | 307 | layers minimally needed by the build system. However, you must manually |
308 | add any custom layers you have created. You can find more information on | 308 | add any custom layers you have created. You can find more information on |
309 | working with the ``bblayers.conf`` file in the | 309 | working with the ``bblayers.conf`` file in the |
310 | ":ref:`dev-manual/common-tasks:enabling your layer`" | 310 | ":ref:`dev-manual/layers:enabling your layer`" |
311 | section in the Yocto Project Development Tasks Manual. | 311 | section in the Yocto Project Development Tasks Manual. |
312 | 312 | ||
313 | The files ``site.conf`` and ``auto.conf`` are not created by the | 313 | The files ``site.conf`` and ``auto.conf`` are not created by the |
@@ -398,7 +398,7 @@ a ``README`` file as good practice and especially if the layer is to be | |||
398 | distributed, a configuration directory, and recipe directories. You can | 398 | distributed, a configuration directory, and recipe directories. You can |
399 | learn about the general structure for layers used with the Yocto Project | 399 | learn about the general structure for layers used with the Yocto Project |
400 | in the | 400 | in the |
401 | ":ref:`dev-manual/common-tasks:creating your own layer`" | 401 | ":ref:`dev-manual/layers:creating your own layer`" |
402 | section in the | 402 | section in the |
403 | Yocto Project Development Tasks Manual. For a general discussion on | 403 | Yocto Project Development Tasks Manual. For a general discussion on |
404 | layers and the many layers from which you can draw, see the | 404 | layers and the many layers from which you can draw, see the |
@@ -798,7 +798,7 @@ For more information on how the source directories are created, see the | |||
798 | ":ref:`overview-manual/concepts:source fetching`" section. For | 798 | ":ref:`overview-manual/concepts:source fetching`" section. For |
799 | more information on how to create patches and how the build system | 799 | more information on how to create patches and how the build system |
800 | processes patches, see the | 800 | processes patches, see the |
801 | ":ref:`dev-manual/common-tasks:patching code`" | 801 | ":ref:`dev-manual/new-recipe:patching code`" |
802 | section in the | 802 | section in the |
803 | Yocto Project Development Tasks Manual. You can also see the | 803 | Yocto Project Development Tasks Manual. You can also see the |
804 | ":ref:`sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" | 804 | ":ref:`sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" |
@@ -999,7 +999,7 @@ stage of package installation, post installation scripts that are part | |||
999 | of the packages are run. Any scripts that fail to run on the build host | 999 | of the packages are run. Any scripts that fail to run on the build host |
1000 | are run on the target when the target system is first booted. If you are | 1000 | are run on the target when the target system is first booted. If you are |
1001 | using a | 1001 | using a |
1002 | :ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`, | 1002 | :ref:`read-only root filesystem <dev-manual/read-only-rootfs:creating a read-only root filesystem>`, |
1003 | all the post installation scripts must succeed on the build host during | 1003 | all the post installation scripts must succeed on the build host during |
1004 | the package installation phase since the root filesystem on the target | 1004 | the package installation phase since the root filesystem on the target |
1005 | is read-only. | 1005 | is read-only. |
@@ -1158,7 +1158,7 @@ varflag. If some other task depends on such a task, then that task will | |||
1158 | also always be considered out of date, which might not be what you want. | 1158 | also always be considered out of date, which might not be what you want. |
1159 | 1159 | ||
1160 | For details on how to view information about a task's signature, see the | 1160 | For details on how to view information about a task's signature, see the |
1161 | ":ref:`dev-manual/common-tasks:viewing task variable dependencies`" | 1161 | ":ref:`dev-manual/debugging:viewing task variable dependencies`" |
1162 | section in the Yocto Project Development Tasks Manual. | 1162 | section in the Yocto Project Development Tasks Manual. |
1163 | 1163 | ||
1164 | Setscene Tasks and Shared State | 1164 | Setscene Tasks and Shared State |
@@ -1583,15 +1583,15 @@ them if they are deemed to be valid. | |||
1583 | the shared state packages. Consequently, there are considerations that | 1583 | the shared state packages. Consequently, there are considerations that |
1584 | affect maintaining shared state feeds. For information on how the | 1584 | affect maintaining shared state feeds. For information on how the |
1585 | build system works with packages and can track incrementing :term:`PR` | 1585 | build system works with packages and can track incrementing :term:`PR` |
1586 | information, see the ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" | 1586 | information, see the ":ref:`dev-manual/packages:automatically incrementing a package version number`" |
1587 | section in the Yocto Project Development Tasks Manual. | 1587 | section in the Yocto Project Development Tasks Manual. |
1588 | 1588 | ||
1589 | - The code in the build system that supports incremental builds is | 1589 | - The code in the build system that supports incremental builds is |
1590 | complex. For techniques that help you work around issues | 1590 | complex. For techniques that help you work around issues |
1591 | related to shared state code, see the | 1591 | related to shared state code, see the |
1592 | ":ref:`dev-manual/common-tasks:viewing metadata used to create the input signature of a shared state task`" | 1592 | ":ref:`dev-manual/debugging:viewing metadata used to create the input signature of a shared state task`" |
1593 | and | 1593 | and |
1594 | ":ref:`dev-manual/common-tasks:invalidating shared state to force a task to run`" | 1594 | ":ref:`dev-manual/debugging:invalidating shared state to force a task to run`" |
1595 | sections both in the Yocto Project Development Tasks Manual. | 1595 | sections both in the Yocto Project Development Tasks Manual. |
1596 | 1596 | ||
1597 | The rest of this section goes into detail about the overall incremental | 1597 | The rest of this section goes into detail about the overall incremental |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 7d5953db33..0d931df3dc 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -93,7 +93,7 @@ are several ways of working in the Yocto Project environment: | |||
93 | through your Linux distribution and the Yocto Project. | 93 | through your Linux distribution and the Yocto Project. |
94 | 94 | ||
95 | For a general flow of the build procedures, see the | 95 | For a general flow of the build procedures, see the |
96 | ":ref:`dev-manual/common-tasks:building a simple image`" | 96 | ":ref:`dev-manual/building:building a simple image`" |
97 | section in the Yocto Project Development Tasks Manual. | 97 | section in the Yocto Project Development Tasks Manual. |
98 | 98 | ||
99 | - *Board Support Package (BSP) Development:* Development of BSPs | 99 | - *Board Support Package (BSP) Development:* Development of BSPs |
@@ -244,7 +244,7 @@ and so forth. | |||
244 | 244 | ||
245 | For information on finding out who is responsible for (maintains) a | 245 | For information on finding out who is responsible for (maintains) a |
246 | particular area of code in the Yocto Project, see the | 246 | particular area of code in the Yocto Project, see the |
247 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" | 247 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" |
248 | section of the Yocto Project Development Tasks Manual. | 248 | section of the Yocto Project Development Tasks Manual. |
249 | 249 | ||
250 | The Yocto Project ``poky`` Git repository also has an upstream | 250 | The Yocto Project ``poky`` Git repository also has an upstream |
@@ -276,7 +276,7 @@ push them into the "contrib" area and subsequently request that the | |||
276 | maintainer include them into an upstream branch. This process is called | 276 | maintainer include them into an upstream branch. This process is called |
277 | "submitting a patch" or "submitting a change." For information on | 277 | "submitting a patch" or "submitting a change." For information on |
278 | submitting patches and changes, see the | 278 | submitting patches and changes, see the |
279 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" | 279 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" |
280 | section in the Yocto Project Development Tasks Manual. | 280 | section in the Yocto Project Development Tasks Manual. |
281 | 281 | ||
282 | In summary, there is a single point of entry for changes into the | 282 | In summary, there is a single point of entry for changes into the |
@@ -343,7 +343,7 @@ Book <https://book.git-scm.com>`__. | |||
343 | the ``scripts`` folder of the | 343 | the ``scripts`` folder of the |
344 | :term:`Source Directory`. For information | 344 | :term:`Source Directory`. For information |
345 | on how to use these scripts, see the | 345 | on how to use these scripts, see the |
346 | ":ref:`dev-manual/common-tasks:using scripts to push a change upstream and request a pull`" | 346 | ":ref:`dev-manual/changes:using scripts to push a change upstream and request a pull`" |
347 | section in the Yocto Project Development Tasks Manual. | 347 | section in the Yocto Project Development Tasks Manual. |
348 | 348 | ||
349 | - *Patch Workflow:* This workflow allows you to notify the maintainer | 349 | - *Patch Workflow:* This workflow allows you to notify the maintainer |
@@ -352,7 +352,7 @@ Book <https://book.git-scm.com>`__. | |||
352 | this type of change, you format the patch and then send the email | 352 | this type of change, you format the patch and then send the email |
353 | using the Git commands ``git format-patch`` and ``git send-email``. | 353 | using the Git commands ``git format-patch`` and ``git send-email``. |
354 | For information on how to use these scripts, see the | 354 | For information on how to use these scripts, see the |
355 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" | 355 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" |
356 | section in the Yocto Project Development Tasks Manual. | 356 | section in the Yocto Project Development Tasks Manual. |
357 | 357 | ||
358 | Git | 358 | Git |
@@ -647,5 +647,5 @@ Project uses in the ``meta/files/common-licenses`` directory in your | |||
647 | For information that can help you maintain compliance with various open | 647 | For information that can help you maintain compliance with various open |
648 | source licensing during the lifecycle of a product created using the | 648 | source licensing during the lifecycle of a product created using the |
649 | Yocto Project, see the | 649 | Yocto Project, see the |
650 | ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 650 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
651 | section in the Yocto Project Development Tasks Manual. | 651 | section in the Yocto Project Development Tasks Manual. |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 8b476f43c4..600b46910e 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -129,7 +129,7 @@ Here are features and advantages of the Yocto Project: | |||
129 | arbitrarily include packages. | 129 | arbitrarily include packages. |
130 | 130 | ||
131 | - *License Manifest:* The Yocto Project provides a :ref:`license | 131 | - *License Manifest:* The Yocto Project provides a :ref:`license |
132 | manifest <dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle>` | 132 | manifest <dev-manual/licenses:maintaining open source license compliance during your product's lifecycle>` |
133 | for review by people who need to track the use of open source | 133 | for review by people who need to track the use of open source |
134 | licenses (e.g. legal teams). | 134 | licenses (e.g. legal teams). |
135 | 135 | ||
@@ -225,7 +225,7 @@ your Metadata, the easier it is to cope with future changes. | |||
225 | 225 | ||
226 | - Layers support the inclusion of technologies, hardware components, | 226 | - Layers support the inclusion of technologies, hardware components, |
227 | and software components. The :ref:`Yocto Project | 227 | and software components. The :ref:`Yocto Project |
228 | Compatible <dev-manual/common-tasks:making sure your layer is compatible with yocto project>` | 228 | Compatible <dev-manual/layers:making sure your layer is compatible with yocto project>` |
229 | designation provides a minimum level of standardization that | 229 | designation provides a minimum level of standardization that |
230 | contributes to a strong ecosystem. "YP Compatible" is applied to | 230 | contributes to a strong ecosystem. "YP Compatible" is applied to |
231 | appropriate products and software components such as BSPs, other | 231 | appropriate products and software components such as BSPs, other |
@@ -269,7 +269,7 @@ of the ``poky`` repository, you will see several layers: ``meta``, | |||
269 | layer. | 269 | layer. |
270 | 270 | ||
271 | For procedures on how to create layers, see the | 271 | For procedures on how to create layers, see the |
272 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 272 | ":ref:`dev-manual/layers:understanding and creating layers`" |
273 | section in the Yocto Project Development Tasks Manual. | 273 | section in the Yocto Project Development Tasks Manual. |
274 | 274 | ||
275 | Components and Tools | 275 | Components and Tools |
@@ -351,7 +351,7 @@ Yocto Project: | |||
351 | (BitBake and | 351 | (BitBake and |
352 | OE-Core) automatically generates upgrades for recipes that are based | 352 | OE-Core) automatically generates upgrades for recipes that are based |
353 | on new versions of the recipes published upstream. See | 353 | on new versions of the recipes published upstream. See |
354 | :ref:`dev-manual/common-tasks:using the auto upgrade helper (auh)` | 354 | :ref:`dev-manual/upgrading-recipes:using the auto upgrade helper (auh)` |
355 | for how to set it up. | 355 | for how to set it up. |
356 | 356 | ||
357 | - *Recipe Reporting System:* The Recipe Reporting System tracks recipe | 357 | - *Recipe Reporting System:* The Recipe Reporting System tracks recipe |
@@ -776,7 +776,7 @@ helpful for getting started: | |||
776 | Yocto Project. | 776 | Yocto Project. |
777 | 777 | ||
778 | For more detailed information on layers, see the | 778 | For more detailed information on layers, see the |
779 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 779 | ":ref:`dev-manual/layers:understanding and creating layers`" |
780 | section in the Yocto Project Development Tasks Manual. For a | 780 | section in the Yocto Project Development Tasks Manual. For a |
781 | discussion specifically on BSP Layers, see the | 781 | discussion specifically on BSP Layers, see the |
782 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto | 782 | ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto |