From 644ad4bf1e30fcee4b9d5abb819046d1f2193d27 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 29 Jun 2012 06:58:01 -0700 Subject: documentation/bsp-guide/bsp.xml: Yocto term paring Pared down the use of the term Yocto Project. (From yocto-docs rev: d62747ca1d42cae703d1cd307dfe16bb9682b741) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.xml | 73 ++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 37 deletions(-) (limited to 'documentation/bsp-guide') 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 BBLAYERS variable in the conf/bblayers.conf file found in the - Yocto Project Build Directory. - Adding the root allows the Yocto Project build system to recognize the BSP + build directory. + Adding the root allows the OpenEmbedded build system to recognize the BSP definition and from it build an image. Here is an example: @@ -99,13 +99,14 @@ - 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 @@ - The conf/layer.conf 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 conf/layer.conf 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 "bsp" and "_bsp" with the actual name @@ -333,7 +335,7 @@ 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. @@ -348,7 +350,7 @@ 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 @@ Tuning files are found in the meta/conf/machine/include - directory of the - Yocto Project Files. + directory within the + source directory. Tuning files can also reside in the BSP Layer itself. For example, the ia32-base.inc file resides in the meta-intel BSP Layer in conf/machine/include. @@ -441,7 +443,7 @@ formfactor recipe meta/recipes-bsp/formfactor/formfactor_0.0.bb, which is found in the - Yocto Project Files. + source directory. @@ -573,10 +575,10 @@ The file also points to some configuration fragments to use by setting the KERNEL_FEATURES variable. The location for the configuration fragments is the kernel tree itself in the - Yocto Project Build - Directory under linux/meta. + build directory + under linux/meta. Finally, the append file points to the specific commits in the - Yocto Project Files Git + source directory Git repository and the meta Git repository branches to identify the exact kernel needed to build the Crown Bay BSP. @@ -629,7 +631,7 @@ For example, if you are working with a local clone of the kernel repository, you could checkout the kernel's meta 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 meta 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 @@ 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 "BSP Layers" and the "Understanding and Creating Layers" in the Yocto Project Development Manual. @@ -719,15 +721,15 @@ recipe-* subdirectory. You can find recipes.txt in the meta directory of the - Yocto - Project Files, or in the OpenEmbedded Core Layer + source directory, + or in the OpenEmbedded Core Layer (openembedded-core) found at . Within any particular recipes-* category, the layout should match what is found in the OpenEmbedded Core Git repository (openembedded-core) - or the Yocto Project Files (poky). + or the source directory (poky). In other words, make sure you place related files in appropriately related recipes-* 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 @@ - 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: Use the LICENSE_FLAGS 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: 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 BSP layer 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 yocto-bsp and yocto-kernel, respectively. @@ -1051,8 +1052,7 @@ Both tools reside in the scripts/ subdirectory - of the Yocto Project - Files. + of the source directory. Consequently, to use the scripts, you must source the environment just as you would when invoking a build: @@ -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 @@ The remainder of the prompts are routine. Defaults are accepted for each. By default, the script creates the new BSP Layer in the - Yocto Project - Build Directory. + build directory. + @@ -1336,8 +1336,7 @@ Managing Kernel Patches and Config Items with yocto-kernel - Assuming you have created a Yocto Project - BSP Layer using + Assuming you have created a BSP Layer using yocto-bsp and you added it to your BBLAYERS @@ -1348,7 +1347,7 @@ The yocto-kernel 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 .bbappend 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 -- cgit v1.2.3-54-g00ecf