diff options
-rw-r--r-- | documentation/bsp-guide/bsp.xml | 44 |
1 files changed, 24 insertions, 20 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 5db2837963..e80c37970a 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -88,7 +88,7 @@ | |||
88 | For more information on how to set up a local copy of source files | 88 | For more information on how to set up a local copy of source files |
89 | from a Git repository, see the | 89 | from a Git repository, see the |
90 | "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>" | 90 | "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>" |
91 | section also in the Yocto Project Development Manual. | 91 | section also in the Yocto Project Development Tasks Manual. |
92 | </para> | 92 | </para> |
93 | 93 | ||
94 | <para> | 94 | <para> |
@@ -139,7 +139,7 @@ | |||
139 | <para> | 139 | <para> |
140 | For more detailed information on layers, see the | 140 | For more detailed information on layers, see the |
141 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 141 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
142 | section of the Yocto Project Development Manual. | 142 | section of the Yocto Project Development Tasks Manual. |
143 | </para> | 143 | </para> |
144 | </section> | 144 | </section> |
145 | 145 | ||
@@ -164,7 +164,7 @@ | |||
164 | Be sure you are set up to use BitBake in a shell. | 164 | Be sure you are set up to use BitBake in a shell. |
165 | See the | 165 | See the |
166 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up the Development Host to Use the Yocto Project</ulink>" | 166 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Setting Up the Development Host to Use the Yocto Project</ulink>" |
167 | section in the Yocto Project Development Manual for information | 167 | section in the Yocto Project Development Tasks Manual for information |
168 | on how to get a build host ready that is either a native | 168 | on how to get a build host ready that is either a native |
169 | Linux machine or a machine that uses CROPS. | 169 | Linux machine or a machine that uses CROPS. |
170 | </para></listitem> | 170 | </para></listitem> |
@@ -179,7 +179,7 @@ | |||
179 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out by Branch in Poky</ulink>" | 179 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out by Branch in Poky</ulink>" |
180 | and | 180 | and |
181 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checkout-out-by-tag-in-poky'>Checking Out by Tag in Poky</ulink>" | 181 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checkout-out-by-tag-in-poky'>Checking Out by Tag in Poky</ulink>" |
182 | sections all in the Yocto Project Development Manual for | 182 | sections all in the Yocto Project Development Tasks Manual for |
183 | information on how to clone the <filename>poky</filename> | 183 | information on how to clone the <filename>poky</filename> |
184 | repository and check out the appropriate branch for your work. | 184 | repository and check out the appropriate branch for your work. |
185 | </para></listitem> | 185 | </para></listitem> |
@@ -236,7 +236,7 @@ | |||
236 | For an example on how to discover branch names and | 236 | For an example on how to discover branch names and |
237 | checkout on a branch, see the | 237 | checkout on a branch, see the |
238 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out By Branch in Poky</ulink>" | 238 | "<ulink url='&YOCTO_DOCS_DEV_URL;#checking-out-by-branch-in-poky'>Checking Out By Branch in Poky</ulink>" |
239 | section. | 239 | section in the Yocto Project Development Tasks Manual. |
240 | </para></listitem> | 240 | </para></listitem> |
241 | </orderedlist> | 241 | </orderedlist> |
242 | </para></listitem> | 242 | </para></listitem> |
@@ -711,7 +711,7 @@ | |||
711 | <para> | 711 | <para> |
712 | Tuning files are found in the <filename>meta/conf/machine/include</filename> | 712 | Tuning files are found in the <filename>meta/conf/machine/include</filename> |
713 | directory within the | 713 | directory within the |
714 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 714 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
715 | For example, the <filename>ia32-base.inc</filename> file resides in the | 715 | For example, the <filename>ia32-base.inc</filename> file resides in the |
716 | <filename>meta/conf/machine/include</filename> directory. | 716 | <filename>meta/conf/machine/include</filename> directory. |
717 | </para> | 717 | </para> |
@@ -767,7 +767,7 @@ | |||
767 | formfactor recipe | 767 | formfactor recipe |
768 | <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, | 768 | <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, |
769 | which is found in the | 769 | which is found in the |
770 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 770 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
771 | </para></note> | 771 | </para></note> |
772 | </section> | 772 | </section> |
773 | 773 | ||
@@ -807,7 +807,7 @@ | |||
807 | <para> | 807 | <para> |
808 | For your BSP, you typically want to use an existing Yocto | 808 | For your BSP, you typically want to use an existing Yocto |
809 | Project kernel recipe found in the | 809 | Project kernel recipe found in the |
810 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 810 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink> |
811 | at <filename>meta/recipes-kernel/linux</filename>. | 811 | at <filename>meta/recipes-kernel/linux</filename>. |
812 | You can append machine-specific changes to the kernel recipe | 812 | You can append machine-specific changes to the kernel recipe |
813 | by using a similarly named append file, which is located in | 813 | by using a similarly named append file, which is located in |
@@ -928,7 +928,7 @@ | |||
928 | about. | 928 | about. |
929 | For more information on layers, see the | 929 | For more information on layers, see the |
930 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" | 930 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" |
931 | section in the Yocto Project Development Manual. | 931 | section in the Yocto Project Development Tasks Manual. |
932 | For more information on BSP layers, see the | 932 | For more information on BSP layers, see the |
933 | "<link linkend='bsp-layers'>BSP Layers</link>" | 933 | "<link linkend='bsp-layers'>BSP Layers</link>" |
934 | section. | 934 | section. |
@@ -1018,7 +1018,7 @@ | |||
1018 | of your new layer. | 1018 | of your new layer. |
1019 | See the | 1019 | See the |
1020 | "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-your-layer'>Enabling Your Layer</ulink>" | 1020 | "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-your-layer'>Enabling Your Layer</ulink>" |
1021 | section in the Yocto Project Development Manual | 1021 | section in the Yocto Project Development Tasks Manual |
1022 | for information on how to let the build system | 1022 | for information on how to let the build system |
1023 | know about your new layer.</para> | 1023 | know about your new layer.</para> |
1024 | 1024 | ||
@@ -1070,24 +1070,28 @@ | |||
1070 | For guidelines on creating a layer that meets these base requirements, see the | 1070 | For guidelines on creating a layer that meets these base requirements, see the |
1071 | "<link linkend='bsp-layers'>BSP Layers</link>" and the | 1071 | "<link linkend='bsp-layers'>BSP Layers</link>" and the |
1072 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding | 1072 | "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding |
1073 | and Creating Layers"</ulink> in the Yocto Project Development Manual.</para></listitem> | 1073 | and Creating Layers"</ulink> in the Yocto Project Development Tasks Manual. |
1074 | </para></listitem> | ||
1074 | <listitem><para>The requirements in this section apply regardless of how you | 1075 | <listitem><para>The requirements in this section apply regardless of how you |
1075 | package a BSP. | 1076 | package a BSP. |
1076 | You should consult the packaging and distribution guidelines for your | 1077 | You should consult the packaging and distribution guidelines for your |
1077 | specific release process. | 1078 | specific release process. |
1078 | For an example of packaging and distribution requirements, see the | 1079 | For an example of packaging and distribution requirements, see the |
1079 | "<ulink url='https://wiki.yoctoproject.org/wiki/Third_Party_BSP_Release_Process'>Third Party BSP Release Process</ulink>" | 1080 | "<ulink url='https://wiki.yoctoproject.org/wiki/Third_Party_BSP_Release_Process'>Third Party BSP Release Process</ulink>" |
1080 | wiki page.</para></listitem> | 1081 | wiki page. |
1082 | </para></listitem> | ||
1081 | <listitem><para>The requirements for the BSP as it is made available to a developer | 1083 | <listitem><para>The requirements for the BSP as it is made available to a developer |
1082 | are completely independent of the released form of the BSP. | 1084 | are completely independent of the released form of the BSP. |
1083 | For example, the BSP Metadata can be contained within a Git repository | 1085 | For example, the BSP Metadata can be contained within a Git repository |
1084 | and could have a directory structure completely different from what appears | 1086 | and could have a directory structure completely different from what appears |
1085 | in the officially released BSP layer.</para></listitem> | 1087 | in the officially released BSP layer. |
1088 | </para></listitem> | ||
1086 | <listitem><para>It is not required that specific packages or package | 1089 | <listitem><para>It is not required that specific packages or package |
1087 | modifications exist in the BSP layer, beyond the requirements for general | 1090 | modifications exist in the BSP layer, beyond the requirements for general |
1088 | compliance with the Yocto Project. | 1091 | compliance with the Yocto Project. |
1089 | For example, no requirement exists dictating that a specific kernel or | 1092 | For example, no requirement exists dictating that a specific kernel or |
1090 | kernel version be used in a given BSP.</para></listitem> | 1093 | kernel version be used in a given BSP. |
1094 | </para></listitem> | ||
1091 | </itemizedlist> | 1095 | </itemizedlist> |
1092 | </para> | 1096 | </para> |
1093 | 1097 | ||
@@ -1114,7 +1118,7 @@ | |||
1114 | <filename>recipes-*</filename> subdirectory. | 1118 | <filename>recipes-*</filename> subdirectory. |
1115 | You can find <filename>recipes.txt</filename> in the | 1119 | You can find <filename>recipes.txt</filename> in the |
1116 | <filename>meta</filename> directory of the | 1120 | <filename>meta</filename> directory of the |
1117 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, | 1121 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, |
1118 | or in the OpenEmbedded Core Layer | 1122 | or in the OpenEmbedded Core Layer |
1119 | (<filename>openembedded-core</filename>) found at | 1123 | (<filename>openembedded-core</filename>) found at |
1120 | <ulink url='http://git.openembedded.org/openembedded-core/tree/meta'></ulink>. | 1124 | <ulink url='http://git.openembedded.org/openembedded-core/tree/meta'></ulink>. |
@@ -1171,7 +1175,7 @@ | |||
1171 | be sent. | 1175 | be sent. |
1172 | For information on how to find the right person, see the | 1176 | For information on how to find the right person, see the |
1173 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>" | 1177 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>" |
1174 | section in the Yocto Project Development Manual. | 1178 | section in the Yocto Project Development Tasks Manual. |
1175 | </para></listitem> | 1179 | </para></listitem> |
1176 | <listitem><para>Instructions on how to build the BSP using the BSP | 1180 | <listitem><para>Instructions on how to build the BSP using the BSP |
1177 | layer.</para></listitem> | 1181 | layer.</para></listitem> |
@@ -1275,7 +1279,7 @@ | |||
1275 | file for the modified recipe. | 1279 | file for the modified recipe. |
1276 | For information on using append files, see the | 1280 | For information on using append files, see the |
1277 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" | 1281 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" |
1278 | section in the Yocto Project Development Manual. | 1282 | section in the Yocto Project Development Tasks Manual. |
1279 | </para></listitem> | 1283 | </para></listitem> |
1280 | <listitem><para> | 1284 | <listitem><para> |
1281 | Ensure your directory structure in the BSP layer | 1285 | Ensure your directory structure in the BSP layer |
@@ -1493,7 +1497,7 @@ | |||
1493 | 1497 | ||
1494 | <para> | 1498 | <para> |
1495 | Both tools reside in the <filename>scripts/</filename> subdirectory | 1499 | Both tools reside in the <filename>scripts/</filename> subdirectory |
1496 | of the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 1500 | of the <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>. |
1497 | Consequently, to use the scripts, you must <filename>source</filename> the | 1501 | Consequently, to use the scripts, you must <filename>source</filename> the |
1498 | environment just as you would when invoking a build: | 1502 | environment just as you would when invoking a build: |
1499 | <literallayout class='monospaced'> | 1503 | <literallayout class='monospaced'> |
@@ -1593,7 +1597,7 @@ | |||
1593 | a "generic" layer. | 1597 | a "generic" layer. |
1594 | For information on this tool, see the | 1598 | For information on this tool, see the |
1595 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" | 1599 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" |
1596 | section in the Yocto Project Development Guide. | 1600 | section in the Yocto Project Development Tasks Manual. |
1597 | </note> | 1601 | </note> |
1598 | </para> | 1602 | </para> |
1599 | 1603 | ||
@@ -1743,7 +1747,7 @@ | |||
1743 | Defaults are accepted for each.</para></listitem> | 1747 | Defaults are accepted for each.</para></listitem> |
1744 | <listitem><para>By default, the script creates the new BSP Layer in the | 1748 | <listitem><para>By default, the script creates the new BSP Layer in the |
1745 | current working directory of the | 1749 | current working directory of the |
1746 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, | 1750 | <ulink url='&YOCTO_DOCS_REF_URL;#source-directory'>Source Directory</ulink>, |
1747 | (i.e. <filename>poky/build</filename>). | 1751 | (i.e. <filename>poky/build</filename>). |
1748 | </para></listitem> | 1752 | </para></listitem> |
1749 | </orderedlist> | 1753 | </orderedlist> |