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/bsp-guide | |
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/bsp-guide')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 117056ebd1..23c70b5a30 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -127,7 +127,7 @@ you want to work with, such as:: | |||
127 | and so on. | 127 | and so on. |
128 | 128 | ||
129 | For more information on layers, see the | 129 | For more information on layers, see the |
130 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 130 | ":ref:`dev-manual/layers:understanding and creating layers`" |
131 | section of the Yocto Project Development Tasks Manual. | 131 | section of the Yocto Project Development Tasks Manual. |
132 | 132 | ||
133 | Preparing Your Build Host to Work With BSP Layers | 133 | Preparing Your Build Host to Work With BSP Layers |
@@ -463,7 +463,7 @@ requirements are handled with the ``COPYING.MIT`` file. | |||
463 | Licensing files can be MIT, BSD, GPLv*, and so forth. These files are | 463 | Licensing files can be MIT, BSD, GPLv*, and so forth. These files are |
464 | recommended for the BSP but are optional and totally up to the BSP | 464 | recommended for the BSP but are optional and totally up to the BSP |
465 | developer. For information on how to maintain license compliance, see | 465 | developer. For information on how to maintain license compliance, see |
466 | the ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" | 466 | the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
467 | section in the Yocto Project Development Tasks Manual. | 467 | section in the Yocto Project Development Tasks Manual. |
468 | 468 | ||
469 | README File | 469 | README File |
@@ -589,7 +589,7 @@ filenames correspond to the values to which users have set the | |||
589 | 589 | ||
590 | These files define things such as the kernel package to use | 590 | These files define things such as the kernel package to use |
591 | (:term:`PREFERRED_PROVIDER` of | 591 | (:term:`PREFERRED_PROVIDER` of |
592 | :ref:`virtual/kernel <dev-manual/common-tasks:using virtual providers>`), | 592 | :ref:`virtual/kernel <dev-manual/new-recipe:using virtual providers>`), |
593 | the hardware drivers to include in different types of images, any | 593 | the hardware drivers to include in different types of images, any |
594 | special software components that are needed, any bootloader information, | 594 | special software components that are needed, any bootloader information, |
595 | and also any special image format requirements. | 595 | and also any special image format requirements. |
@@ -757,7 +757,7 @@ workflow. | |||
757 | OpenEmbedded build system knows about. For more information on | 757 | OpenEmbedded build system knows about. For more information on |
758 | layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" | 758 | layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" |
759 | section in the Yocto Project Overview and Concepts Manual. You can also | 759 | section in the Yocto Project Overview and Concepts Manual. You can also |
760 | reference the ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 760 | reference the ":ref:`dev-manual/layers:understanding and creating layers`" |
761 | section in the Yocto Project Development Tasks Manual. For more | 761 | section in the Yocto Project Development Tasks Manual. For more |
762 | information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" | 762 | information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" |
763 | section. | 763 | section. |
@@ -816,7 +816,7 @@ workflow. | |||
816 | key configuration files are configured appropriately: the | 816 | key configuration files are configured appropriately: the |
817 | ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must | 817 | ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must |
818 | make the OpenEmbedded build system aware of your new layer. See the | 818 | make the OpenEmbedded build system aware of your new layer. See the |
819 | ":ref:`dev-manual/common-tasks:enabling your layer`" | 819 | ":ref:`dev-manual/layers:enabling your layer`" |
820 | section in the Yocto Project Development Tasks Manual for information | 820 | section in the Yocto Project Development Tasks Manual for information |
821 | on how to let the build system know about your new layer. | 821 | on how to let the build system know about your new layer. |
822 | 822 | ||
@@ -845,7 +845,7 @@ Before looking at BSP requirements, you should consider the following: | |||
845 | layer that can be added to the Yocto Project. For guidelines on | 845 | layer that can be added to the Yocto Project. For guidelines on |
846 | creating a layer that meets these base requirements, see the | 846 | creating a layer that meets these base requirements, see the |
847 | ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the | 847 | ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the |
848 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 848 | ":ref:`dev-manual/layers:understanding and creating layers`" |
849 | section in the Yocto Project Development Tasks Manual. | 849 | section in the Yocto Project Development Tasks Manual. |
850 | 850 | ||
851 | - The requirements in this section apply regardless of how you package | 851 | - The requirements in this section apply regardless of how you package |
@@ -927,7 +927,7 @@ Yocto Project: | |||
927 | - The name and contact information for the BSP layer maintainer. | 927 | - The name and contact information for the BSP layer maintainer. |
928 | This is the person to whom patches and questions should be sent. | 928 | This is the person to whom patches and questions should be sent. |
929 | For information on how to find the right person, see the | 929 | For information on how to find the right person, see the |
930 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" | 930 | ":ref:`dev-manual/changes:submitting a change to the yocto project`" |
931 | section in the Yocto Project Development Tasks Manual. | 931 | section in the Yocto Project Development Tasks Manual. |
932 | 932 | ||
933 | - Instructions on how to build the BSP using the BSP layer. | 933 | - Instructions on how to build the BSP using the BSP layer. |
@@ -1013,7 +1013,7 @@ the following: | |||
1013 | 1013 | ||
1014 | - Create a ``*.bbappend`` file for the modified recipe. For information on using | 1014 | - Create a ``*.bbappend`` file for the modified recipe. For information on using |
1015 | append files, see the | 1015 | append files, see the |
1016 | ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" | 1016 | ":ref:`dev-manual/layers:appending other layers metadata with your layer`" |
1017 | section in the Yocto Project Development Tasks Manual. | 1017 | section in the Yocto Project Development Tasks Manual. |
1018 | 1018 | ||
1019 | - Ensure your directory structure in the BSP layer that supports your | 1019 | - Ensure your directory structure in the BSP layer that supports your |
@@ -1117,7 +1117,7 @@ list describes them in order of preference: | |||
1117 | Specifying the matching license string signifies that you agree to | 1117 | Specifying the matching license string signifies that you agree to |
1118 | the license. Thus, the build system can build the corresponding | 1118 | the license. Thus, the build system can build the corresponding |
1119 | recipe and include the component in the image. See the | 1119 | recipe and include the component in the image. See the |
1120 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" | 1120 | ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" |
1121 | section in the Yocto Project Development Tasks Manual for details on | 1121 | section in the Yocto Project Development Tasks Manual for details on |
1122 | how to use these variables. | 1122 | how to use these variables. |
1123 | 1123 | ||
@@ -1169,7 +1169,7 @@ Use these steps to create a BSP layer: | |||
1169 | ``create-layer`` subcommand to create a new general layer. For | 1169 | ``create-layer`` subcommand to create a new general layer. For |
1170 | instructions on how to create a general layer using the | 1170 | instructions on how to create a general layer using the |
1171 | ``bitbake-layers`` script, see the | 1171 | ``bitbake-layers`` script, see the |
1172 | ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 1172 | ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" |
1173 | section in the Yocto Project Development Tasks Manual. | 1173 | section in the Yocto Project Development Tasks Manual. |
1174 | 1174 | ||
1175 | - *Create a Layer Configuration File:* Every layer needs a layer | 1175 | - *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 | |||
1229 | :yocto_git:`Source Repositories <>`. | 1229 | :yocto_git:`Source Repositories <>`. |
1230 | 1230 | ||
1231 | For a detailed description of this particular layer configuration file, | 1231 | For a detailed description of this particular layer configuration file, |
1232 | see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`" | 1232 | see ":ref:`step 3 <dev-manual/layers:creating your own layer>`" |
1233 | in the discussion that describes how to create layers in the Yocto | 1233 | in the discussion that describes how to create layers in the Yocto |
1234 | Project Development Tasks Manual. | 1234 | Project Development Tasks Manual. |
1235 | 1235 | ||