diff options
Diffstat (limited to 'documentation/bsp-guide/bsp.rst')
| -rw-r--r-- | documentation/bsp-guide/bsp.rst | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 357e740a5c..6d3ccd49b3 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
| @@ -72,7 +72,7 @@ For information on typical BSP development workflow, see the | |||
| 72 | section. For more | 72 | section. For more |
| 73 | information on how to set up a local copy of source files from a Git | 73 | information on how to set up a local copy of source files from a Git |
| 74 | repository, see the | 74 | repository, see the |
| 75 | :ref:`dev-manual/dev-manual-start:locating yocto project source files` | 75 | :ref:`dev-manual/start:locating yocto project source files` |
| 76 | section in the Yocto Project Development Tasks Manual. | 76 | section in the Yocto Project Development Tasks Manual. |
| 77 | 77 | ||
| 78 | The BSP layer's base directory (``meta-bsp_root_name``) is the root | 78 | The BSP layer's base directory (``meta-bsp_root_name``) is the root |
| @@ -128,7 +128,7 @@ you want to work with, such as: :: | |||
| 128 | and so on. | 128 | and so on. |
| 129 | 129 | ||
| 130 | For more information on layers, see the | 130 | For more information on layers, see the |
| 131 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 131 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
| 132 | section of the Yocto Project Development Tasks Manual. | 132 | section of the Yocto Project Development Tasks Manual. |
| 133 | 133 | ||
| 134 | Preparing Your Build Host to Work With BSP Layers | 134 | Preparing Your Build Host to Work With BSP Layers |
| @@ -146,7 +146,7 @@ section. | |||
| 146 | :ref:`bsp-guide/bsp:example filesystem layout` section. | 146 | :ref:`bsp-guide/bsp:example filesystem layout` section. |
| 147 | 147 | ||
| 148 | #. *Set Up the Build Environment:* Be sure you are set up to use BitBake | 148 | #. *Set Up the Build Environment:* Be sure you are set up to use BitBake |
| 149 | in a shell. See the ":ref:`dev-manual/dev-manual-start:preparing the build host`" | 149 | in a shell. See the ":ref:`dev-manual/start:preparing the build host`" |
| 150 | section in the Yocto Project Development Tasks Manual for information on how | 150 | section in the Yocto Project Development Tasks Manual for information on how |
| 151 | to get a build host ready that is either a native Linux machine or a machine | 151 | to get a build host ready that is either a native Linux machine or a machine |
| 152 | that uses CROPS. | 152 | that uses CROPS. |
| @@ -154,10 +154,10 @@ section. | |||
| 154 | #. *Clone the poky Repository:* You need to have a local copy of the | 154 | #. *Clone the poky Repository:* You need to have a local copy of the |
| 155 | Yocto Project :term:`Source Directory` (i.e. a local | 155 | Yocto Project :term:`Source Directory` (i.e. a local |
| 156 | ``poky`` repository). See the | 156 | ``poky`` repository). See the |
| 157 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" and | 157 | ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and |
| 158 | possibly the | 158 | possibly the |
| 159 | ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" or | 159 | ":ref:`dev-manual/start:checking out by branch in poky`" or |
| 160 | ":ref:`dev-manual/dev-manual-start:checking out by tag in poky`" | 160 | ":ref:`dev-manual/start:checking out by tag in poky`" |
| 161 | sections | 161 | sections |
| 162 | all in the Yocto Project Development Tasks Manual for information on | 162 | all in the Yocto Project Development Tasks Manual for information on |
| 163 | how to clone the ``poky`` repository and check out the appropriate | 163 | how to clone the ``poky`` repository and check out the appropriate |
| @@ -205,7 +205,7 @@ section. | |||
| 205 | 205 | ||
| 206 | To see the available branch names in a cloned repository, use the ``git | 206 | To see the available branch names in a cloned repository, use the ``git |
| 207 | branch -al`` command. See the | 207 | branch -al`` command. See the |
| 208 | ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" | 208 | ":ref:`dev-manual/start:checking out by branch in poky`" |
| 209 | section in the Yocto Project Development Tasks Manual for more | 209 | section in the Yocto Project Development Tasks Manual for more |
| 210 | information. | 210 | information. |
| 211 | 211 | ||
| @@ -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/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" | 466 | the ":ref:`dev-manual/common-tasks: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/dev-manual-common-tasks:using virtual providers>`), | 592 | :ref:`virtual/kernel <dev-manual/common-tasks: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. |
| @@ -726,7 +726,7 @@ workflow. | |||
| 726 | :align: center | 726 | :align: center |
| 727 | 727 | ||
| 728 | #. *Set up Your Host Development System to Support Development Using the | 728 | #. *Set up Your Host Development System to Support Development Using the |
| 729 | Yocto Project*: See the ":ref:`dev-manual/dev-manual-start:preparing the build host`" | 729 | Yocto Project*: See the ":ref:`dev-manual/start:preparing the build host`" |
| 730 | section in the Yocto Project Development Tasks Manual for options on how to | 730 | section in the Yocto Project Development Tasks Manual for options on how to |
| 731 | get a system ready to use the Yocto Project. | 731 | get a system ready to use the Yocto Project. |
| 732 | 732 | ||
| @@ -756,7 +756,7 @@ workflow. | |||
| 756 | OpenEmbedded build system knows about. For more information on | 756 | OpenEmbedded build system knows about. For more information on |
| 757 | layers, see the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" | 757 | layers, see the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" |
| 758 | section in the Yocto Project Overview and Concepts Manual. You can also | 758 | section in the Yocto Project Overview and Concepts Manual. You can also |
| 759 | reference the ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 759 | reference the ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
| 760 | section in the Yocto Project Development Tasks Manual. For more | 760 | section in the Yocto Project Development Tasks Manual. For more |
| 761 | information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" | 761 | information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" |
| 762 | section. | 762 | section. |
| @@ -815,7 +815,7 @@ workflow. | |||
| 815 | key configuration files are configured appropriately: the | 815 | key configuration files are configured appropriately: the |
| 816 | ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must | 816 | ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must |
| 817 | make the OpenEmbedded build system aware of your new layer. See the | 817 | make the OpenEmbedded build system aware of your new layer. See the |
| 818 | ":ref:`dev-manual/dev-manual-common-tasks:enabling your layer`" | 818 | ":ref:`dev-manual/common-tasks:enabling your layer`" |
| 819 | section in the Yocto Project Development Tasks Manual for information | 819 | section in the Yocto Project Development Tasks Manual for information |
| 820 | on how to let the build system know about your new layer. | 820 | on how to let the build system know about your new layer. |
| 821 | 821 | ||
| @@ -846,7 +846,7 @@ Before looking at BSP requirements, you should consider the following: | |||
| 846 | layer that can be added to the Yocto Project. For guidelines on | 846 | layer that can be added to the Yocto Project. For guidelines on |
| 847 | creating a layer that meets these base requirements, see the | 847 | creating a layer that meets these base requirements, see the |
| 848 | ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the | 848 | ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the |
| 849 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 849 | ":ref:`dev-manual/common-tasks:understanding and creating layers`" |
| 850 | section in the Yocto Project Development Tasks Manual. | 850 | section in the Yocto Project Development Tasks Manual. |
| 851 | 851 | ||
| 852 | - The requirements in this section apply regardless of how you package | 852 | - The requirements in this section apply regardless of how you package |
| @@ -928,7 +928,7 @@ Yocto Project: | |||
| 928 | - The name and contact information for the BSP layer maintainer. | 928 | - The name and contact information for the BSP layer maintainer. |
| 929 | This is the person to whom patches and questions should be sent. | 929 | This is the person to whom patches and questions should be sent. |
| 930 | For information on how to find the right person, see the | 930 | For information on how to find the right person, see the |
| 931 | ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" | 931 | ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" |
| 932 | section in the Yocto Project Development Tasks Manual. | 932 | section in the Yocto Project Development Tasks Manual. |
| 933 | 933 | ||
| 934 | - Instructions on how to build the BSP using the BSP layer. | 934 | - Instructions on how to build the BSP using the BSP layer. |
| @@ -1013,7 +1013,7 @@ If you plan on customizing a recipe for a particular BSP, you need to do | |||
| 1013 | the following: | 1013 | the following: |
| 1014 | 1014 | ||
| 1015 | - Create a ``*.bbappend`` file for the modified recipe. For information on using | 1015 | - Create a ``*.bbappend`` file for the modified recipe. For information on using |
| 1016 | append files, see the ":ref:`dev-manual/dev-manual-common-tasks:using | 1016 | append files, see the ":ref:`dev-manual/common-tasks:using |
| 1017 | .bbappend files in your layer`" section in the Yocto Project Development | 1017 | .bbappend files in your layer`" section in the Yocto Project Development |
| 1018 | Tasks Manual. | 1018 | Tasks Manual. |
| 1019 | 1019 | ||
| @@ -1118,7 +1118,7 @@ list describes them in order of preference: | |||
| 1118 | Specifying the matching license string signifies that you agree to | 1118 | Specifying the matching license string signifies that you agree to |
| 1119 | the license. Thus, the build system can build the corresponding | 1119 | the license. Thus, the build system can build the corresponding |
| 1120 | recipe and include the component in the image. See the | 1120 | recipe and include the component in the image. See the |
| 1121 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" | 1121 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" |
| 1122 | section in the Yocto Project Development Tasks Manual for details on | 1122 | section in the Yocto Project Development Tasks Manual for details on |
| 1123 | how to use these variables. | 1123 | how to use these variables. |
| 1124 | 1124 | ||
| @@ -1170,7 +1170,7 @@ Use these steps to create a BSP layer: | |||
| 1170 | ``create-layer`` subcommand to create a new general layer. For | 1170 | ``create-layer`` subcommand to create a new general layer. For |
| 1171 | instructions on how to create a general layer using the | 1171 | instructions on how to create a general layer using the |
| 1172 | ``bitbake-layers`` script, see the | 1172 | ``bitbake-layers`` script, see the |
| 1173 | ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" | 1173 | ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" |
| 1174 | section in the Yocto Project Development Tasks Manual. | 1174 | section in the Yocto Project Development Tasks Manual. |
| 1175 | 1175 | ||
| 1176 | - *Create a Layer Configuration File:* Every layer needs a layer | 1176 | - *Create a Layer Configuration File:* Every layer needs a layer |
| @@ -1230,7 +1230,7 @@ configuration files is to examine various files for BSP from the | |||
| 1230 | :yocto_git:`Source Repositories <>`. | 1230 | :yocto_git:`Source Repositories <>`. |
| 1231 | 1231 | ||
| 1232 | For a detailed description of this particular layer configuration file, | 1232 | For a detailed description of this particular layer configuration file, |
| 1233 | see ":ref:`step 3 <dev-manual/dev-manual-common-tasks:creating your own layer>`" | 1233 | see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`" |
| 1234 | in the discussion that describes how to create layers in the Yocto | 1234 | in the discussion that describes how to create layers in the Yocto |
| 1235 | Project Development Tasks Manual. | 1235 | Project Development Tasks Manual. |
| 1236 | 1236 | ||
