manuals: split dev-manual/common-tasks.rst
PATCH 1/1 manuals: split dev-manual/common-tasks.rst
From: Michael Opdenacker <[email protected]>
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.
--- documentation/brief-yoctoprojectqs/index.rst | 4 +- documentation/bsp-guide/bsp.rst | 22 +- documentation/dev-manual/bmaptool.rst | 59 + documentation/dev-manual/build-quality.rst | 411 + documentation/dev-manual/building.rst | 940 ++ documentation/dev-manual/changes.rst | 525 + documentation/dev-manual/common-tasks.rst | 11861 ---------------- .../dev-manual/custom-distribution.rst | 108 + ...ustom-template-configuration-directory.rst | 52 + .../dev-manual/customizing-images.rst | 223 + documentation/dev-manual/debugging.rst | 1253 ++ .../dev-manual/development-shell.rst | 82 + documentation/dev-manual/device-manager.rst | 72 + documentation/dev-manual/disk-space.rst | 40 + .../efficiently-fetching-sources.rst | 68 + .../dev-manual/error-reporting-tool.rst | 85 + documentation/dev-manual/external-scm.rst | 67 + .../dev-manual/external-toolchain.rst | 28 + .../dev-manual/gobject-introspection.rst | 157 + documentation/dev-manual/index.rst | 38 +- documentation/dev-manual/init-manager.rst | 89 + documentation/dev-manual/layers.rst | 905 ++ documentation/dev-manual/libraries.rst | 267 + documentation/dev-manual/licenses.rst | 520 + documentation/dev-manual/new-machine.rst | 118 + documentation/dev-manual/new-recipe.rst | 1674 +++ documentation/dev-manual/packages.rst | 1252 ++ .../dev-manual/prebuilt-libraries.rst | 209 + .../dev-manual/python-development-shell.rst | 50 + documentation/dev-manual/quilt.rst | 90 + documentation/dev-manual/read-only-rootfs.rst | 89 + documentation/dev-manual/runtime-testing.rst | 599 + documentation/dev-manual/sbom.rst | 68 + documentation/dev-manual/securing-images.rst | 158 + .../dev-manual/speeding-up-build.rst | 110 + documentation/dev-manual/start.rst | 6 +- .../dev-manual/temporary-source-code.rst | 66 + .../dev-manual/upgrading-recipes.rst | 400 + documentation/dev-manual/vulnerabilities.rst | 214 + documentation/dev-manual/wayland.rst | 90 + documentation/dev-manual/wic.rst | 732 + documentation/dev-manual/x32-psabi.rst | 54 + documentation/kernel-dev/common.rst | 16 +- documentation/kernel-dev/faq.rst | 2 +- documentation/kernel-dev/intro.rst | 2 +- .../migration-guides/migration-1.4.rst | 2 +- .../migration-guides/migration-1.5.rst | 4 +- .../migration-guides/migration-1.6.rst | 6 +- .../migration-guides/migration-1.7.rst | 2 +- .../migration-guides/migration-2.1.rst | 2 +- .../migration-guides/migration-2.3.rst | 2 +- .../migration-guides/migration-2.5.rst | 2 +- .../migration-guides/migration-2.6.rst | 2 +- .../migration-guides/migration-general.rst | 2 +- documentation/overview-manual/concepts.rst | 20 +- .../development-environment.rst | 12 +- documentation/overview-manual/yp-intro.rst | 10 +- documentation/ref-manual/classes.rst | 38 +- .../ref-manual/devtool-reference.rst | 4 +- documentation/ref-manual/faq.rst | 6 +- documentation/ref-manual/features.rst | 8 +- documentation/ref-manual/images.rst | 4 +- documentation/ref-manual/kickstart.rst | 2 +- documentation/ref-manual/release-process.rst | 4 +- documentation/ref-manual/resources.rst | 4 +- documentation/ref-manual/structure.rst | 12 +- .../ref-manual/system-requirements.rst | 2 +- documentation/ref-manual/tasks.rst | 10 +- documentation/ref-manual/terms.rst | 8 +- documentation/ref-manual/variables.rst | 112 +- documentation/sdk-manual/extensible.rst | 4 +- documentation/test-manual/intro.rst | 2 +- .../test-manual/yocto-project-compatible.rst | 2 +- documentation/toaster-manual/reference.rst | 2 +- .../transitioning-to-a-custom-environment.rst | 8 +- documentation/what-i-wish-id-known.rst | 2 +- 76 files changed, 12137 insertions(+), 12038 deletions(-) create mode 100644 documentation/dev-manual/bmaptool.rst create mode 100644 documentation/dev-manual/build-quality.rst create mode 100644 documentation/dev-manual/building.rst create mode 100644 documentation/dev-manual/changes.rst delete mode 100644 documentation/dev-manual/common-tasks.rst create mode 100644 documentation/dev-manual/custom-distribution.rst create mode 100644 documentation/dev-manual/custom-template-configuration-directory.rst create mode 100644 documentation/dev-manual/customizing-images.rst create mode 100644 documentation/dev-manual/debugging.rst create mode 100644 documentation/dev-manual/development-shell.rst create mode 100644 documentation/dev-manual/device-manager.rst create mode 100644 documentation/dev-manual/disk-space.rst create mode 100644 documentation/dev-manual/efficiently-fetching-sources.rst create mode 100644 documentation/dev-manual/error-reporting-tool.rst create mode 100644 documentation/dev-manual/external-scm.rst create mode 100644 documentation/dev-manual/external-toolchain.rst create mode 100644 documentation/dev-manual/gobject-introspection.rst create mode 100644 documentation/dev-manual/init-manager.rst create mode 100644 documentation/dev-manual/layers.rst create mode 100644 documentation/dev-manual/libraries.rst create mode 100644 documentation/dev-manual/licenses.rst create mode 100644 documentation/dev-manual/new-machine.rst create mode 100644 documentation/dev-manual/new-recipe.rst create mode 100644 documentation/dev-manual/packages.rst create mode 100644 documentation/dev-manual/prebuilt-libraries.rst create mode 100644 documentation/dev-manual/python-development-shell.rst create mode 100644 documentation/dev-manual/quilt.rst create mode 100644 documentation/dev-manual/read-only-rootfs.rst create mode 100644 documentation/dev-manual/runtime-testing.rst create mode 100644 documentation/dev-manual/sbom.rst create mode 100644 documentation/dev-manual/securing-images.rst create mode 100644 documentation/dev-manual/speeding-up-build.rst create mode 100644 documentation/dev-manual/temporary-source-code.rst create mode 100644 documentation/dev-manual/upgrading-recipes.rst create mode 100644 documentation/dev-manual/vulnerabilities.rst create mode 100644 documentation/dev-manual/wayland.rst create mode 100644 documentation/dev-manual/wic.rst create mode 100644 documentation/dev-manual/x32-psabi.rst
documentation/brief-yoctoprojectqs/index.rst +2 -2
@@ -361,7 +361,7 @@ Follow these steps to add a hardware layer: You can find more information on adding layers in the - :ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script` + :ref:`dev-manual/layers:adding a layer using the \`\`bitbake-layers\`\` script` section. Completing these steps has added the ``meta-altera`` layer to your Yocto
@@ -396,7 +396,7 @@ The following commands run the tool to create a layer named For more information on layers and how to create them, see the -:ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script` +:ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script` section in the Yocto Project Development Tasks Manual. Where To Go Next
documentation/bsp-guide/bsp.rst +11 -11
@@ -127,7 +127,7 @@ you want to work with, such as:: and so on. For more information on layers, see the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. Preparing Your Build Host to Work With BSP Layers
@@ -463,7 +463,7 @@ requirements are handled with the ``COPYING.MIT`` file. Licensing files can be MIT, BSD, GPLv*, and so forth. These files are recommended for the BSP but are optional and totally up to the BSP developer. For information on how to maintain license compliance, see -the ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. README File
@@ -589,7 +589,7 @@ filenames correspond to the values to which users have set the These files define things such as the kernel package to use (:term:`PREFERRED_PROVIDER` of -:ref:`virtual/kernel <dev-manual/common-tasks:using virtual providers>`), +:ref:`virtual/kernel <dev-manual/new-recipe:using virtual providers>`), the hardware drivers to include in different types of images, any special software components that are needed, any bootloader information, and also any special image format requirements.
@@ -757,7 +757,7 @@ workflow. OpenEmbedded build system knows about. For more information on layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" section in the Yocto Project Overview and Concepts Manual. You can also - reference the ":ref:`dev-manual/common-tasks:understanding and creating layers`" + reference the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. For more information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" section.
@@ -816,7 +816,7 @@ workflow. key configuration files are configured appropriately: the ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must make the OpenEmbedded build system aware of your new layer. See the - ":ref:`dev-manual/common-tasks:enabling your layer`" + ":ref:`dev-manual/layers:enabling your layer`" section in the Yocto Project Development Tasks Manual for information on how to let the build system know about your new layer.
@@ -845,7 +845,7 @@ Before looking at BSP requirements, you should consider the following: layer that can be added to the Yocto Project. For guidelines on creating a layer that meets these base requirements, see the ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. - The requirements in this section apply regardless of how you package
@@ -927,7 +927,7 @@ Yocto Project: - The name and contact information for the BSP layer maintainer. This is the person to whom patches and questions should be sent. For information on how to find the right person, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" + ":ref:`dev-manual/changes:submitting a change to the yocto project`" section in the Yocto Project Development Tasks Manual. - Instructions on how to build the BSP using the BSP layer.
@@ -1013,7 +1013,7 @@ the following: - Create a ``*.bbappend`` file for the modified recipe. For information on using append files, see the - ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual. - Ensure your directory structure in the BSP layer that supports your
@@ -1117,7 +1117,7 @@ list describes them in order of preference: Specifying the matching license string signifies that you agree to the license. Thus, the build system can build the corresponding recipe and include the component in the image. See the - ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" + ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual for details on how to use these variables.
@@ -1169,7 +1169,7 @@ Use these steps to create a BSP layer: ``create-layer`` subcommand to create a new general layer. For instructions on how to create a general layer using the ``bitbake-layers`` script, see the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. - *Create a Layer Configuration File:* Every layer needs a layer
@@ -1229,7 +1229,7 @@ configuration files is to examine various files for BSP from the :yocto_git:`Source Repositories <>`. For a detailed description of this particular layer configuration file, -see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`" +see ":ref:`step 3 <dev-manual/layers:creating your own layer>`" in the discussion that describes how to create layers in the Yocto Project Development Tasks Manual.
documentation/dev-manual/bmaptool.rst new file +59 -0
59 lines not on this page · raw message
documentation/dev-manual/build-quality.rst new file +411 -0
411 lines not on this page · raw message
documentation/dev-manual/building.rst new file +940 -0
940 lines not on this page · raw message
documentation/dev-manual/changes.rst new file +525 -0
525 lines not on this page · raw message
documentation/dev-manual/common-tasks.rst deleted +0 -11861
961 lines not on this page · raw message
documentation/dev-manual/custom-distribution.rst new file +108 -0
108 lines not on this page · raw message
documentation/dev-manual/custom-template-configuration-directory.rst new file +52 -0
52 lines not on this page · raw message
documentation/dev-manual/customizing-images.rst new file +223 -0
223 lines not on this page · raw message
documentation/dev-manual/debugging.rst new file +1253 -0
1,253 lines not on this page · raw message
documentation/dev-manual/development-shell.rst new file +82 -0
82 lines not on this page · raw message
documentation/dev-manual/device-manager.rst new file +72 -0
72 lines not on this page · raw message
documentation/dev-manual/disk-space.rst new file +40 -0
Lines of this file are not shown. View the raw message.
documentation/dev-manual/efficiently-fetching-sources.rst new file +68 -0
68 lines not on this page · raw message
documentation/dev-manual/error-reporting-tool.rst new file +85 -0
85 lines not on this page · raw message
documentation/dev-manual/external-scm.rst new file +67 -0
67 lines not on this page · raw message
documentation/dev-manual/external-toolchain.rst new file +28 -0
Lines of this file are not shown. View the raw message.
documentation/dev-manual/gobject-introspection.rst new file +157 -0
157 lines not on this page · raw message
documentation/dev-manual/init-manager.rst new file +89 -0
89 lines not on this page · raw message
documentation/dev-manual/layers.rst new file +905 -0
905 lines not on this page · raw message
documentation/dev-manual/libraries.rst new file +267 -0
267 lines not on this page · raw message
documentation/dev-manual/licenses.rst new file +520 -0
520 lines not on this page · raw message
documentation/dev-manual/new-machine.rst new file +118 -0
118 lines not on this page · raw message
documentation/dev-manual/new-recipe.rst new file +1674 -0
1,674 lines not on this page · raw message
documentation/dev-manual/packages.rst new file +1252 -0
1,252 lines not on this page · raw message
documentation/dev-manual/prebuilt-libraries.rst new file +209 -0
209 lines not on this page · raw message
documentation/dev-manual/python-development-shell.rst new file +50 -0
50 lines not on this page · raw message
documentation/dev-manual/quilt.rst new file +90 -0
90 lines not on this page · raw message
documentation/dev-manual/read-only-rootfs.rst new file +89 -0
89 lines not on this page · raw message
documentation/dev-manual/runtime-testing.rst new file +599 -0
599 lines not on this page · raw message
documentation/dev-manual/sbom.rst new file +68 -0
68 lines not on this page · raw message
documentation/dev-manual/securing-images.rst new file +158 -0
158 lines not on this page · raw message
documentation/dev-manual/speeding-up-build.rst new file +110 -0
110 lines not on this page · raw message
documentation/dev-manual/temporary-source-code.rst new file +66 -0
66 lines not on this page · raw message
documentation/dev-manual/upgrading-recipes.rst new file +400 -0
400 lines not on this page · raw message
documentation/dev-manual/vulnerabilities.rst new file +214 -0
214 lines not on this page · raw message
documentation/dev-manual/wayland.rst new file +90 -0
90 lines not on this page · raw message
documentation/dev-manual/wic.rst new file +732 -0
732 lines not on this page · raw message
documentation/dev-manual/x32-psabi.rst new file +54 -0
54 lines not on this page · raw message
documentation/migration-guides/migration-1.4.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-1.5.rst +2 -2
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-1.6.rst +3 -3
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-1.7.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-2.1.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-2.3.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-2.5.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-2.6.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/migration-guides/migration-general.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/overview-manual/concepts.rst +10 -10
Lines of this file are not shown. View the raw message.
documentation/overview-manual/development-environment.rst +6 -6
Lines of this file are not shown. View the raw message.
documentation/overview-manual/yp-intro.rst +5 -5
Lines of this file are not shown. View the raw message.
documentation/ref-manual/devtool-reference.rst +2 -2
Lines of this file are not shown. View the raw message.
documentation/ref-manual/release-process.rst +2 -2
Lines of this file are not shown. View the raw message.
documentation/ref-manual/system-requirements.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/ref-manual/variables.rst +56 -56
112 lines not on this page · raw message
documentation/sdk-manual/extensible.rst +2 -2
Lines of this file are not shown. View the raw message.
documentation/test-manual/yocto-project-compatible.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/toaster-manual/reference.rst +1 -1
Lines of this file are not shown. View the raw message.
documentation/transitioning-to-a-custom-environment.rst +4 -4
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.34.1
Part of the diff is not shown here. View the raw message.