diff options
| -rw-r--r-- | documentation/bsp-guide/bsp.xml | 73 |
1 files changed, 36 insertions, 37 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 6fd61c0291..a1a678b1c1 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -48,8 +48,8 @@ This root is what you add to the <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> variable in the <filename>conf/bblayers.conf</filename> file found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'>Yocto Project Build Directory</ulink>. - Adding the root allows the Yocto Project build system to recognize the BSP + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. + Adding the root allows the OpenEmbedded build system to recognize the BSP definition and from it build an image. Here is an example: <literallayout class='monospaced'> @@ -99,13 +99,14 @@ </para> <para> - The proposed form does have elements that are specific to the Yocto Project and - OpenEmbedded build systems. + The proposed form does have elements that are specific to the + OpenEmbedded build system. It is intended that this information can be - used by other systems besides Yocto Project and OpenEmbedded and that it will be simple + used by other build systems besides the OpenEmbedded build system + and that it will be simple to extract information and convert it to other formats if required. - Yocto Project, through its standard layers mechanism, can directly accept the format - described as a layer. + The OpenEmbedded build system, through its standard layers mechanism, can directly + accept the format described as a layer. The BSP captures all the hardware-specific details in one place in a standard format, which is useful for any person wishing to use the hardware platform regardless of @@ -297,9 +298,10 @@ </para> <para> - The <filename>conf/layer.conf</filename> file identifies the file structure as a Yocto - Project layer, identifies the - contents of the layer, and contains information about how Yocto Project should use it. + The <filename>conf/layer.conf</filename> file identifies the file structure as a + layer, identifies the + contents of the layer, and contains information about how the build + system should use it. Generally, a standard boilerplate file such as the following works. In the following example, you would replace "<filename>bsp</filename>" and "<filename>_bsp</filename>" with the actual name @@ -333,7 +335,7 @@ <para> This file simply makes BitBake aware of the recipes and configuration directories. - The file must exist so that the Yocto Project build system can recognize the BSP. + The file must exist so that the OpenEmbedded build system can recognize the BSP. </para> </section> @@ -348,7 +350,7 @@ <para> The machine files bind together all the information contained elsewhere - in the BSP into a format that the Yocto Project build system can understand. + in the BSP into a format that the build system can understand. If the BSP supports multiple machines, multiple machine configuration files can be present. These filenames correspond to the values to which users have set the @@ -388,8 +390,8 @@ <para> Tuning files are found in the <filename>meta/conf/machine/include</filename> - directory of the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>. + directory within the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. Tuning files can also reside in the BSP Layer itself. For example, the <filename>ia32-base.inc</filename> file resides in the <filename>meta-intel</filename> BSP Layer in <filename>conf/machine/include</filename>. @@ -441,7 +443,7 @@ formfactor recipe <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, which is found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink>. + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. </para></note> </section> @@ -573,10 +575,10 @@ The file also points to some configuration fragments to use by setting the <filename>KERNEL_FEATURES</filename> variable. The location for the configuration fragments is the kernel tree itself in the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'>Yocto Project Build - Directory</ulink> under <filename>linux/meta</filename>. + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> + under <filename>linux/meta</filename>. Finally, the append file points to the specific commits in the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink> Git + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> Git repository and the <filename>meta</filename> Git repository branches to identify the exact kernel needed to build the Crown Bay BSP. </para> @@ -629,7 +631,7 @@ For example, if you are working with a local clone of the kernel repository, you could checkout the kernel's <filename>meta</filename> branch, make your changes, and then push the changes to the local bare clone of the kernel. - The result is that you directly add configuration options to the Yocto kernel + The result is that you directly add configuration options to the <filename>meta</filename> branch for your BSP. The configuration options will likely end up in that location anyway if the BSP gets added to the Yocto Project. @@ -672,7 +674,7 @@ <itemizedlist> <listitem><para>The requirements here assume the BSP layer is a well-formed, "legal" layer that can be added to the Yocto Project. - For guidelines on creating a Yocto Project layer that meets these base requirements, see the + For guidelines on creating a layer that meets these base requirements, see the "<link linkend='bsp-layers'>BSP Layers</link>" and the "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers"</ulink> in the Yocto Project Development Manual.</para></listitem> @@ -719,15 +721,15 @@ <filename>recipe-*</filename> subdirectory. You can find <filename>recipes.txt</filename> in the <filename>meta</filename> directory of the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto - Project Files</ulink>, or in the OpenEmbedded Core Layer + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>, + or in the OpenEmbedded Core Layer (<filename>openembedded-core</filename>) found at <ulink url='http://git.openembedded.org/openembedded-core/tree/meta'></ulink>. </para> <para>Within any particular <filename>recipes-*</filename> category, the layout should match what is found in the OpenEmbedded Core Git repository (<filename>openembedded-core</filename>) - or the Yocto Project Files (<filename>poky</filename>). + or the source directory (<filename>poky</filename>). In other words, make sure you place related files in appropriately related <filename>recipes-*</filename> subdirectories specific to the recipe's function, or within a subdirectory containing a set of closely-related @@ -910,7 +912,7 @@ for a component or components. For these cases, you are required to accept the terms of a commercial or other type of license that requires some kind of explicit End User License Agreement (EULA). - Once the license is accepted, the Yocto Project build system can then build and + Once the license is accepted, the OpenEmbedded build system can then build and include the corresponding component in the final BSP image. If the BSP is available as a pre-built image, you can download the image after agreeing to the license or EULA. @@ -953,13 +955,12 @@ </para> <para> - A couple different methods exist within the Yocto - Project build system to satisfy the licensing - requirements for an encumbered BSP. + A couple different methods exist within the OpenEmbedded build system to + satisfy the licensing requirements for an encumbered BSP. The following list describes them in order of preference: <orderedlist> <listitem><para><emphasis>Use the <filename>LICENSE_FLAGS</filename> variable - to define the Yocto Project recipes that have commercial or other types of + to define the recipes that have commercial or other types of specially-licensed packages:</emphasis> For each of those recipes, you can specify a matching license string in a @@ -1024,7 +1025,7 @@ The Yocto Project includes a couple of tools that enable you to create a <link linkend='bsp-layers'>BSP layer</link> from scratch and do basic configuration and maintenance - of the kernel without ever looking at a Yocto Project metadata file. + of the kernel without ever looking at a metadata file. These tools are <filename>yocto-bsp</filename> and <filename>yocto-kernel</filename>, respectively. </para> @@ -1051,8 +1052,7 @@ <para> Both tools reside in the <filename>scripts/</filename> subdirectory - of the <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project - Files</ulink>. + of the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. Consequently, to use the scripts, you must <filename>source</filename> the environment just as you would when invoking a build: <literallayout class='monospaced'> @@ -1104,7 +1104,7 @@ [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>] This command creates a Yocto BSP based on the specified parameters. - The new BSP will be a new Yocto BSP layer contained by default within + The new BSP will be a new BSP layer contained by default within the top-level directory specified as 'meta-bsp-name'. The -o option can be used to place the BSP layer in a directory with a different name and location. @@ -1310,8 +1310,8 @@ <listitem><para>The remainder of the prompts are routine. Defaults are accepted for each.</para></listitem> <listitem><para>By default, the script creates the new BSP Layer in the - <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'>Yocto Project - Build Directory</ulink>.</para></listitem> + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. + </para></listitem> </orderedlist> </para> @@ -1336,8 +1336,7 @@ <title>Managing Kernel Patches and Config Items with yocto-kernel</title> <para> - Assuming you have created a Yocto Project - <link linkend='bsp-layers'>BSP Layer</link> using + Assuming you have created a <link linkend='bsp-layers'>BSP Layer</link> using <link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'> <filename>yocto-bsp</filename></link> and you added it to your <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> @@ -1348,7 +1347,7 @@ <para> The <filename>yocto-kernel</filename> script allows you to add, remove, and list patches - and kernel config settings to a Yocto Project BSP's kernel + and kernel config settings to a BSP's kernel <filename>.bbappend</filename> file. All you need to do is use the appropriate sub-command. Recall that the easiest way to see exactly what sub-commands are available |