diff options
| author |   Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-12-07 17:21:20 -0600 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-11 16:15:24 +0000 |
| commit | eb8c9e1494692583f77d83267f78d5d88a79973d (patch) | |
| tree | 14c2fc28df0901ba57430d1b36112281e53de455 /documentation/bsp-guide | |
| parent | 3bcdba62b186c554033357bb50de0b20d115a54d (diff) | |
| download | openembedded-core-contrib-eb8c9e1494692583f77d83267f78d5d88a79973d.tar.gz | |
Documentation: bsp-guide - Removed all trailing whitespace.
(From yocto-docs rev: 00d9bb4dcce101a77761418c1279ebfb9441b0d2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/bsp-guide')
| -rw-r--r-- | documentation/bsp-guide/bsp-guide.xml | 18 | ||||
| -rw-r--r-- | documentation/bsp-guide/bsp.xml | 546 |
2 files changed, 282 insertions, 282 deletions
diff --git a/documentation/bsp-guide/bsp-guide.xml b/documentation/bsp-guide/bsp-guide.xml index 5f7551ef38..4bbc0c5a4c 100644 --- a/documentation/bsp-guide/bsp-guide.xml +++ b/documentation/bsp-guide/bsp-guide.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > -<book id='bsp-guide' lang='en' +<book id='bsp-guide' lang='en' xmlns:xi="http://www.w3.org/2003/XInclude" xmlns="http://docbook.org/ns/docbook" > @@ -10,13 +10,13 @@ <mediaobject> <imageobject> - <imagedata fileref='figures/bsp-title.png' - format='SVG' + <imagedata fileref='figures/bsp-title.png' + format='SVG' align='center' scalefit='1' width='100%'/> - </imageobject> + </imageobject> </mediaobject> - <title></title> + <title></title> <authorgroup> <author> @@ -80,12 +80,12 @@ <legalnotice> <para> - Permission is granted to copy, distribute and/or modify this document under + Permission is granted to copy, distribute and/or modify this document under the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Non-Commercial-Share Alike 2.0 UK: England & Wales</ulink> as published by Creative Commons. </para> <note> Due to production processes, there could be differences between the Yocto Project - documentation bundled in the release tarball and the + documentation bundled in the release tarball and the <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink> on the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. For the latest version of this manual, see the manual on the website. @@ -102,6 +102,6 @@ --> </book> -<!-- -vim: expandtab tw=80 ts=4 +<!-- +vim: expandtab tw=80 ts=4 --> diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 020e3508fa..94415a679c 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -8,13 +8,13 @@ <para> A Board Support Package (BSP) is a collection of information that - defines how to support a particular hardware device, set of devices, or - hardware platform. - The BSP includes information about the hardware features - present on the device and kernel configuration information along with any + defines how to support a particular hardware device, set of devices, or + hardware platform. + The BSP includes information about the hardware features + present on the device and kernel configuration information along with any additional hardware drivers required. - The BSP also lists any additional software - components required in addition to a generic Linux software stack for both + The BSP also lists any additional software + components required in addition to a generic Linux software stack for both essential and optional platform features. </para> @@ -22,8 +22,8 @@ This guide presents information about BSP Layers, defines a structure for components so that BSPs follow a commonly understood layout, discusses how to customize a recipe for a BSP, addresses BSP licensing, and provides information that - shows you how to create and manage a - <link linkend='bsp-layers'>BSP Layer</link> using two Yocto Project + shows you how to create and manage a + <link linkend='bsp-layers'>BSP Layer</link> using two Yocto Project <link linkend='using-the-yocto-projects-bsp-tools'>BSP Tools</link>. </para> @@ -32,7 +32,7 @@ <para> The BSP consists of a file structure inside a base directory. - Collectively, you can think of the base directory and the file structure + Collectively, you can think of the base directory and the file structure as a BSP Layer. BSP Layers use the following naming convention: <literallayout class='monospaced'> @@ -42,13 +42,13 @@ </para> <para> - The layer's base directory (<filename>meta-<bsp_name></filename>) is the root + The layer's base directory (<filename>meta-<bsp_name></filename>) is the root of the BSP Layer. - This root is what you add to the + 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 + variable in the <filename>conf/bblayers.conf</filename> file found in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. - Adding the root allows the OpenEmbedded build system to recognize the BSP + 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'> @@ -70,9 +70,9 @@ Some BSPs require additional layers on top of the BSP's root layer in order to be functional. For these cases, you also need to add those layers to the - <filename>BBLAYERS</filename> variable in order to build the BSP. + <filename>BBLAYERS</filename> variable in order to build the BSP. You must also specify in the "Dependencies" section of the BSP's - <filename>README</filename> file any requirements for additional + <filename>README</filename> file any requirements for additional layers and, preferably, any build instructions that might be contained elsewhere in the <filename>README</filename> file. @@ -80,13 +80,13 @@ <para> Some layers function as a layer to hold other BSP layers. - An example of this type of layer is the <filename>meta-intel</filename> layer. + An example of this type of layer is the <filename>meta-intel</filename> layer. The <filename>meta-intel</filename> layer contains over 10 individual BSP layers. </para> <para> - For more detailed information on layers, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" + For more detailed information on layers, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" section of the Yocto Project Development Manual. </para> </section> @@ -96,38 +96,38 @@ <title>Example Filesystem Layout</title> <para> - Providing a common form allows end-users to understand and become familiar - with the layout. + Providing a common form allows end-users to understand and become familiar + with the layout. A common format also encourages standardization of software support of hardware. </para> <para> - 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 build systems besides the OpenEmbedded build system + 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 build systems besides the OpenEmbedded build system and that it will be simple to extract information and convert it to other formats if required. - The OpenEmbedded build system, through its standard layers mechanism, can directly + 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 + 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 the build system they are using. </para> <para> The BSP specification does not include a build system or other tools - - it is concerned with the hardware-specific components only. + it is concerned with the hardware-specific components only. At the end-distribution point, you can ship the BSP combined with a build system - and other tools. + and other tools. However, it is important to maintain the distinction that these are separate components that happen to be combined in certain end products. </para> <para> - Before looking at the common form for the file structure inside a BSP Layer, - you should be aware that some requirements do exist in order for a BSP to + Before looking at the common form for the file structure inside a BSP Layer, + you should be aware that some requirements do exist in order for a BSP to be considered compliant with the Yocto Project. For that list of requirements, see the "<link linkend='released-bsp-requirements'>Released BSP Requirements</link>" @@ -137,19 +137,19 @@ <para> Below is the common form for the file structure inside a BSP Layer. While you can use this basic form for the standard, realize that the actual structures - for specific BSPs could differ. + for specific BSPs could differ. <literallayout class='monospaced'> - meta-<bsp_name>/ + meta-<bsp_name>/ meta-<bsp_name>/<bsp_license_file> meta-<bsp_name>/README meta-<bsp_name>/README.sources meta-<bsp_name>/binary/<bootable_images> - meta-<bsp_name>/conf/layer.conf + meta-<bsp_name>/conf/layer.conf meta-<bsp_name>/conf/machine/*.conf meta-<bsp_name>/recipes-bsp/* meta-<bsp_name>/recipes-core/* - meta-<bsp_name>/recipes-graphics/* + meta-<bsp_name>/recipes-graphics/* meta-<bsp_name>/recipes-kernel/linux/linux-yocto_<kernel_rev>.bbappend </literallayout> </para> @@ -209,8 +209,8 @@ <para> These optional files satisfy licensing requirements for the BSP. The type or types of files here can vary depending on the licensing requirements. - For example, in the Crown Bay BSP all licensing requirements are handled with the - <filename>COPYING.MIT</filename> file. + For example, in the Crown Bay BSP all licensing requirements are handled with the + <filename>COPYING.MIT</filename> file. </para> <para> @@ -229,9 +229,9 @@ </para> <para> - This file provides information on how to boot the live images that are optionally + This file provides information on how to boot the live images that are optionally included in the <filename>binary/</filename> directory. - The <filename>README</filename> file also provides special information needed for + The <filename>README</filename> file also provides special information needed for building the image. </para> @@ -271,20 +271,20 @@ </para> <para> - This optional area contains useful pre-built kernels and user-space filesystem + This optional area contains useful pre-built kernels and user-space filesystem images appropriate to the target system. - This directory typically contains graphical (e.g. sato) and minimal live images - when the BSP tarball has been created and made available in the - <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. - You can use these kernels and images to get a system running and quickly get started + This directory typically contains graphical (e.g. sato) and minimal live images + when the BSP tarball has been created and made available in the + <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. + You can use these kernels and images to get a system running and quickly get started on development tasks. </para> - <para> + <para> The exact types of binaries present are highly hardware-dependent. - However, a README file should be present in the BSP Layer that explains how to use - the kernels and images with the target hardware. - If pre-built binaries are present, source code to meet licensing requirements must also + However, a README file should be present in the BSP Layer that explains how to use + the kernels and images with the target hardware. + If pre-built binaries are present, source code to meet licensing requirements must also exist in some form. </para> </section> @@ -299,12 +299,12 @@ </para> <para> - The <filename>conf/layer.conf</filename> file identifies the file structure as a - layer, identifies the + 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. + 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 + In the following example, you would replace "<filename>bsp</filename>" and "<filename>_bsp</filename>" with the actual name of the BSP (i.e. <filename><bsp_name></filename> from the example template). </para> @@ -325,7 +325,7 @@ </para> <para> - To illustrate the string substitutions, here are the last three statements from the Crown + To illustrate the string substitutions, here are the last three statements from the Crown Bay <filename>conf/layer.conf</filename> file: <literallayout class='monospaced'> BBFILE_COLLECTIONS += "crownbay" @@ -351,10 +351,10 @@ <para> The machine files bind together all the information contained elsewhere - in the BSP into a format that the 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 + can be present. + These filenames correspond to the values to which users have set the <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable. </para> @@ -370,13 +370,13 @@ <para> Each BSP Layer requires at least one machine file. However, you can supply more than one file. - For example, in the Crown Bay BSP shown earlier in this section, the + For example, in the Crown Bay BSP shown earlier in this section, the <filename>conf/machine</filename> directory contains two configuration files: <filename>crownbay.conf</filename> and <filename>crownbay-noemgd.conf</filename>. The <filename>crownbay.conf</filename> file is used for the Crown Bay BSP that supports the <trademark class='registered'>Intel</trademark> Embedded Media and Graphics Driver (<trademark class='registered'>Intel</trademark> - EMGD), while the <filename>crownbay-noemgd.conf</filename> file is used for the + EMGD), while the <filename>crownbay-noemgd.conf</filename> file is used for the Crown Bay BSP that does not support the <trademark class='registered'>Intel</trademark> EMGD. </para> @@ -384,23 +384,23 @@ <para> This <filename>crownbay.conf</filename> file could also include a hardware "tuning" file that is commonly used to - define the package architecture and specify + define the package architecture and specify optimization flags, which are carefully chosen to give best performance on a given processor. </para> <para> Tuning files are found in the <filename>meta/conf/machine/include</filename> - directory within the + 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 + 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>. </para> <para> - To use an include file, you simply include them in the machine configuration file. - For example, the Crown Bay BSP <filename>crownbay.conf</filename> has the + To use an include file, you simply include them in the machine configuration file. + For example, the Crown Bay BSP <filename>crownbay.conf</filename> has the following statements: <literallayout class='monospaced'> require conf/machine/include/tune-atom.inc @@ -415,19 +415,19 @@ You can find these files in the BSP Layer at: <literallayout class='monospaced'> meta-<bsp_name>/recipes-bsp/* - </literallayout> + </literallayout> </para> <para> This optional directory contains miscellaneous recipe files for the BSP. Most notably would be the formfactor files. - For example, in the Crown Bay BSP there is the - <filename>formfactor_0.0.bbappend</filename> file, which is an append file used - to augment the recipe that starts the build. + For example, in the Crown Bay BSP there is the + <filename>formfactor_0.0.bbappend</filename> file, which is an append file used + to augment the recipe that starts the build. Furthermore, there are machine-specific settings used during the build that are defined by the <filename>machconfig</filename> files. In the Crown Bay example, two <filename>machconfig</filename> files exist: - one that supports the + one that supports the <trademark class='registered'>Intel</trademark> Embedded Media and Graphics Driver (<trademark class='registered'>Intel</trademark> EMGD) and one that does not: @@ -440,10 +440,10 @@ <note><para> If a BSP does not have a formfactor entry, defaults are established according to - the formfactor configuration file that is installed by the main - formfactor recipe - <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, - which is found in the + the formfactor configuration file that is installed by the main + formfactor recipe + <filename>meta/recipes-bsp/formfactor/formfactor_0.0.bb</filename>, + which is found in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. </para></note> </section> @@ -453,19 +453,19 @@ <para> You can find these files in the BSP Layer at: <literallayout class='monospaced'> - meta-<bsp_name>/recipes-graphics/* + meta-<bsp_name>/recipes-graphics/* </literallayout> </para> <para> - This optional directory contains recipes for the BSP if it has + This optional directory contains recipes for the BSP if it has special requirements for graphics support. - All files that are needed for the BSP to support a display are kept here. - For example, the Crown Bay BSP contains two versions of the + All files that are needed for the BSP to support a display are kept here. + For example, the Crown Bay BSP contains two versions of the <filename>xorg.conf</filename> file. - The version in <filename>crownbay</filename> builds a BSP that supports the + The version in <filename>crownbay</filename> builds a BSP that supports the <trademark class='registered'>Intel</trademark> Embedded Media Graphics Driver (EMGD), - while the version in <filename>crownbay-noemgd</filename> builds + while the version in <filename>crownbay-noemgd</filename> builds a BSP that supports Video Electronics Standards Association (VESA) graphics only: <literallayout class='monospaced'> meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend @@ -488,29 +488,29 @@ These files append your specific changes to the main kernel recipe you are using. </para> <para> - For your BSP, you typically want to use an existing Yocto Project kernel recipe found in the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + For your BSP, you typically want to use an existing Yocto Project kernel recipe found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> at <filename>meta/recipes-kernel/linux</filename>. You can append your specific changes to the kernel recipe by using a - similarly named append file, which is located in the BSP Layer (e.g. + similarly named append file, which is located in the BSP Layer (e.g. the <filename>meta-<bsp_name>/recipes-kernel/linux</filename> directory). </para> <para> Suppose you are using the <filename>linux-yocto_3.4.bb</filename> recipe to build the kernel. - In other words, you have selected the kernel in your - <filename><bsp_name>.conf</filename> file by adding these types + In other words, you have selected the kernel in your + <filename><bsp_name>.conf</filename> file by adding these types of statements: <literallayout class='monospaced'> PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" PREFERRED_VERSION_linux-yocto = "3.4%" </literallayout> <note> - When the preferred provider is assumed by default, the - <filename>PREFERRED_PROVIDER</filename> statement does not appear in the + When the preferred provider is assumed by default, the + <filename>PREFERRED_PROVIDER</filename> statement does not appear in the <filename><bsp_name>.conf</filename> file. </note> - You would use the <filename>linux-yocto_3.4.bbappend</filename> file to append + You would use the <filename>linux-yocto_3.4.bbappend</filename> file to append specific BSP settings to the kernel, thus configuring the kernel for your particular BSP. </para> <para> @@ -545,11 +545,11 @@ SRC_URI_crownbay = "git://git.yoctoproject.org/linux-yocto-3.4.git;protocol=git;nocheckout=1;branch=${KBRANCH},meta,emgd-1.14;name=machine,meta,emgd" SRC_URI_crownbay-noemgd = "git://git.yoctoproject.org/linux-yocto-3.4.git;protocol=git;nocheckout=1;branch=${KBRANCH},meta;name=machine,meta" </literallayout> - This append file contains statements used to support the Crown Bay BSP for both + This append file contains statements used to support the Crown Bay BSP for both <trademark class='registered'>Intel</trademark> EMGD and the VESA graphics. - The build process, in this case, recognizes and uses only the statements that + The build process, in this case, recognizes and uses only the statements that apply to the defined machine name - <filename>crownbay</filename> in this case. - So, the applicable statements in the <filename>linux-yocto_3.4.bbappend</filename> + So, the applicable statements in the <filename>linux-yocto_3.4.bbappend</filename> file are follows: <literallayout class='monospaced'> FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" @@ -562,46 +562,46 @@ SRCREV_meta_pn-linux-yocto_crownbay ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac" SRCREV_emgd_pn-linux-yocto_crownbay ?= "86643bdd8cbad616a161ab91f51108cf0da827bc" </literallayout> - The append file defines <filename>crownbay</filename> as the + The append file defines <filename>crownbay</filename> as the <ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></ulink> - and uses the - <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink> variable to - ensure the machine name used by the OpenEmbedded build system maps to the + and uses the + <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink> variable to + ensure the machine name used by the OpenEmbedded build system maps to the machine name used by the Linux Yocto kernel. - The file also uses the optional + The file also uses the optional <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable to ensure the build process uses the <filename>standard/default/crownbay</filename> kernel branch. - Finally, the append file points to specific commits in the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> Git - repository and the <filename>meta</filename> Git repository branches to identify the + Finally, the append file points to specific commits in the + <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. <note> For <filename>crownbay</filename>, a specific commit is also needed to point - to the branch that supports EMGD graphics. - At a minimum, every BSP points to the + to the branch that supports EMGD graphics. + At a minimum, every BSP points to the <filename>machine</filename> and <filename>meta</filename> commits. </note> </para> <para> - One thing missing in this particular BSP, which you will typically need when + One thing missing in this particular BSP, which you will typically need when developing a BSP, is the kernel configuration file (<filename>.config</filename>) for your BSP. When developing a BSP, you probably have a kernel configuration file or a set of kernel configuration files that, when taken together, define the kernel configuration for your BSP. - You can accomplish this definition by putting the configurations in a file or a set of files - inside a directory located at the same level as your kernel's append file and having the same + You can accomplish this definition by putting the configurations in a file or a set of files + inside a directory located at the same level as your kernel's append file and having the same name as the kernel's main recipe file. - With all these conditions met, simply reference those files in a + With all these conditions met, simply reference those files in a <filename>SRC_URI</filename> statement in the append file. </para> <para> - For example, suppose you had a some configuration options in a file called - <filename>network_configs.cfg</filename>. - You can place that file inside a directory named <filename>/linux-yocto</filename> and then add + For example, suppose you had a some configuration options in a file called + <filename>network_configs.cfg</filename>. + You can place that file inside a directory named <filename>/linux-yocto</filename> and then add a <filename>SRC_URI</filename> statement such as the following to the append file. - When the OpenEmbedded build system builds the kernel, the configuration options are + When the OpenEmbedded build system builds the kernel, the configuration options are picked up and applied. <literallayout class='monospaced'> SRC_URI += "file://network_configs.cfg" @@ -609,7 +609,7 @@ </para> <para> - To group related configurations into multiple files, you perform a similar procedure. + To group related configurations into multiple files, you perform a similar procedure. Here is an example that groups separate configurations specifically for Ethernet and graphics into their own files and adds the configurations by using a <filename>SRC_URI</filename> statement like the following in your append file: @@ -621,9 +621,9 @@ </para> <para> - The <filename>FILESEXTRAPATHS</filename> variable is in boilerplate form in the + The <filename>FILESEXTRAPATHS</filename> variable is in boilerplate form in the previous example in order to make it easy to do that. - This variable must be in your layer or BitBake will not find the patches or + This variable must be in your layer or BitBake will not find the patches or configurations even if you have them in your <filename>SRC_URI</filename>. The <filename>FILESEXTRAPATHS</filename> variable enables the build process to find those configuration files. @@ -632,23 +632,23 @@ <note> <para> Other methods exist to accomplish grouping and defining configuration options. - 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, + 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 + 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. + The configuration options will likely end up in that location anyway if the BSP gets + added to the Yocto Project. </para> <para> - In general, however, the Yocto Project maintainers take care of moving the - <filename>SRC_URI</filename>-specified + In general, however, the Yocto Project maintainers take care of moving the + <filename>SRC_URI</filename>-specified configuration options to the kernel's <filename>meta</filename> branch. - Not only is it easier for BSP developers to not have to worry about putting those - configurations in the branch, but having the maintainers do it allows them to apply - 'global' knowledge about the kinds of common configuration options multiple BSPs in - the tree are typically using. + Not only is it easier for BSP developers to not have to worry about putting those + configurations in the branch, but having the maintainers do it allows them to apply + 'global' knowledge about the kinds of common configuration options multiple BSPs in + the tree are typically using. This allows for promotion of common configurations into common features. </para> </note> @@ -661,7 +661,7 @@ <para> Certain requirements exist for a released BSP to be considered compliant with the Yocto Project. - Additionally, a single recommendation also exists. + Additionally, a single recommendation also exists. This section describes the requirements and recommendation for released BSPs. </para> @@ -675,55 +675,55 @@ <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 layer that meets these base requirements, see the - "<link linkend='bsp-layers'>BSP Layers</link>" and 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> - <listitem><para>The requirements in this section apply regardless of how you + <listitem><para>The requirements in this section apply regardless of how you ultimately package a BSP. You should consult the packaging and distribution guidelines for your - specific release process. - For an example of packaging and distribution requirements, see the - <ulink url='https://wiki.yoctoproject.org/wiki/Third_Party_BSP_Release_Process'>Third + specific release process. + For an example of packaging and distribution requirements, see the + <ulink url='https://wiki.yoctoproject.org/wiki/Third_Party_BSP_Release_Process'>Third Party BSP Release Process</ulink> wiki page.</para></listitem> <listitem><para>The requirements for the BSP as it is made available to a developer - are completely independent of the released form of the BSP. + are completely independent of the released form of the BSP. For example, the BSP metadata can be contained within a Git repository and could have a directory structure completely different from what appears in the officially released BSP layer.</para></listitem> - <listitem><para>It is not required that specific packages or package - modifications exist in the BSP layer, beyond the requirements for general + <listitem><para>It is not required that specific packages or package + modifications exist in the BSP layer, beyond the requirements for general compliance with the Yocto Project. - For example, no requirement exists dictating that a specific kernel or + For example, no requirement exists dictating that a specific kernel or kernel version be used in a given BSP.</para></listitem> </itemizedlist> </para> <para> - Following are the requirements for a released BSP that conforms to the + Following are the requirements for a released BSP that conforms to the Yocto Project: <itemizedlist> <listitem><para><emphasis>Layer Name:</emphasis> The BSP must have a layer name that follows the Yocto - Project standards. + Project standards. For information on BSP layer names, see the "<link linkend='bsp-layers'>BSP Layers</link>" section. </para></listitem> <listitem><para><emphasis>File System Layout:</emphasis> - When possible, use the same directory names in your + When possible, use the same directory names in your BSP layer as listed in the <filename>recipes.txt</filename> file. - In particular, you should place recipes + In particular, you should place recipes (<filename>.bb</filename> files) and recipe - modifications (<filename>.bbappend</filename> files) into - <filename>recipes-*</filename> subdirectories by functional area + modifications (<filename>.bbappend</filename> files) into + <filename>recipes-*</filename> subdirectories by functional area as outlined in <filename>recipes.txt</filename>. If you cannot find a category in <filename>recipes.txt</filename> - to fit a particular recipe, you can make up your own + to fit a particular recipe, you can make up your own <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;#source-directory'>Source Directory</ulink>, + <filename>meta</filename> directory of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, or in the OpenEmbedded Core Layer - (<filename>openembedded-core</filename>) found at + (<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 @@ -733,68 +733,68 @@ 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 - recipes. + recipes. The recipes themselves should follow the general guidelines - for recipes used in the Yocto Project found in the + for recipes used in the Yocto Project found in the <ulink url='https://wiki.yoctoproject.org/wiki/Recipe_%26_Patch_Style_Guide'>Yocto Recipe and Patch Style Guide</ulink>.</para></listitem> <listitem><para><emphasis>License File:</emphasis> - You must include a license file in the + You must include a license file in the <filename>meta-<bsp_name></filename> directory. This license covers the BSP metadata as a whole. - You must specify which license to use since there is no + You must specify which license to use since there is no default license if one is not specified. - See the + See the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/COPYING.MIT'><filename>COPYING.MIT</filename></ulink> - file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer + file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer as an example.</para></listitem> <listitem><para><emphasis>README File:</emphasis> - You must include a <filename>README</filename> file in the + You must include a <filename>README</filename> file in the <filename>meta-<bsp_name></filename> directory. - See the + See the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README'><filename>README</filename></ulink> - file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer + file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer as an example.</para> - <para>At a minimum, the <filename>README</filename> file should + <para>At a minimum, the <filename>README</filename> file should contain the following: <itemizedlist> - <listitem><para>A brief description about the hardware the BSP + <listitem><para>A brief description about the hardware the BSP targets.</para></listitem> - <listitem><para>A list of all the dependencies + <listitem><para>A list of all the dependencies on which a BSP layer depends. - These dependencies are typically a list of required layers needed + These dependencies are typically a list of required layers needed to build the BSP. - However, the dependencies should also contain information regarding + However, the dependencies should also contain information regarding any other dependencies the BSP might have.</para></listitem> <listitem><para>Any required special licensing information. - For example, this information includes information on + For example, this information includes information on special variables needed to satisfy a EULA, or instructions on information needed to build or distribute binaries built from the BSP metadata.</para></listitem> - <listitem><para>The name and contact information for the + <listitem><para>The name and contact information for the BSP layer maintainer. This is the person to whom patches and questions should be sent.</para></listitem> - <listitem><para>Instructions on how to build the BSP using the BSP + <listitem><para>Instructions on how to build the BSP using the BSP layer.</para></listitem> - <listitem><para>Instructions on how to boot the BSP build from + <listitem><para>Instructions on how to boot the BSP build from the BSP layer.</para></listitem> - <listitem><para>Instructions on how to boot the binary images - contained in the <filename>/binary</filename> directory, + <listitem><para>Instructions on how to boot the binary images + contained in the <filename>/binary</filename> directory, if present.</para></listitem> - <listitem><para>Information on any known bugs or issues that users - should know about when either building or booting the BSP + <listitem><para>Information on any known bugs or issues that users + should know about when either building or booting the BSP binaries.</para></listitem> </itemizedlist></para></listitem> <listitem><para><emphasis>README.sources File:</emphasis> - You must include a <filename>README.sources</filename> in the + You must include a <filename>README.sources</filename> in the <filename>meta-<bsp_name></filename> directory. - This file specifies exactly where you can find the sources used to - generate the binary images contained in the + This file specifies exactly where you can find the sources used to + generate the binary images contained in the <filename>/binary</filename> directory, if present. - See the + See the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README.sources'><filename>README.sources</filename></ulink> - file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer + file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer as an example.</para></listitem> <listitem><para><emphasis>Layer Configuration File:</emphasis> You must include a <filename>conf/layer.conf</filename> in the @@ -806,19 +806,19 @@ in the <filename>meta-<bsp_name></filename> directory. This configuration file defines a machine target that can be built using the BSP layer. - Multiple machine configuration files define variations of machine + Multiple machine configuration files define variations of machine configurations that are supported by the BSP. - If a BSP supports multiple machine variations, you need to - adequately describe each variation in the BSP + If a BSP supports multiple machine variations, you need to + adequately describe each variation in the BSP <filename>README</filename> file. Do not use multiple machine configuration files to describe disparate - hardware. + hardware. If you do have very different targets, you should create separate BSP layers for each target. - <note>It is completely possible for a developer to structure the + <note>It is completely possible for a developer to structure the working repository as a conglomeration of unrelated BSP - files, and to possibly generate specifically targeted 'release' BSPs - from that directory using scripts or some other mechanism. + files, and to possibly generate specifically targeted 'release' BSPs + from that directory using scripts or some other mechanism. Such considerations are outside the scope of this document.</note> </para></listitem> </itemizedlist> @@ -829,26 +829,26 @@ <title>Released BSP Recommendations</title> <para> - Following are recommendations for a released BSP that conforms to the + Following are recommendations for a released BSP that conforms to the Yocto Project: <itemizedlist> <listitem><para><emphasis>Bootable Images:</emphasis> - BSP releases + BSP releases can contain one or more bootable images. Including bootable images allows users to easily try out the BSP on their own hardware.</para> - <para>In some cases, it might not be convenient to include a - bootable image. - In this case, you might want to make two versions of the + <para>In some cases, it might not be convenient to include a + bootable image. + In this case, you might want to make two versions of the BSP available: one that contains binary images, and one that does not. - The version that does not contain bootable images avoids + The version that does not contain bootable images avoids unnecessary download times for users not interested in the images. </para> <para>If you need to distribute a BSP and include bootable images or build kernel and filesystems meant to allow users to boot the BSP for evaluation - purposes, you should put the images and artifacts within a - <filename>binary/</filename> subdirectory located in the + purposes, you should put the images and artifacts within a + <filename>binary/</filename> subdirectory located in the <filename>meta-<bsp_name></filename> directory. <note>If you do include a bootable image as part of the BSP and the image was built by software covered by the GPL or other open source licenses, @@ -856,10 +856,10 @@ and meet all licensing requirements, which could include distribution of source files.</note></para></listitem> <listitem><para><emphasis>Use a Yocto Linux Kernel:</emphasis> - Kernel recipes in the BSP should be based on a Yocto Linux kernel. - Basing your recipes on these kernels reduces the costs for maintaining + Kernel recipes in the BSP should be based on a Yocto Linux kernel. + Basing your recipes on these kernels reduces the costs for maintaining the BSP and increases its scalability. - See the <filename>Yocto Linux Kernel</filename> category in the + See the <filename>Yocto Linux Kernel</filename> category in the <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Source Repositories</ulink> for these kernels.</para></listitem> </itemizedlist> @@ -883,18 +883,18 @@ </para> <para> - To better understand this, consider an example that customizes a recipe by adding - a BSP-specific configuration file named <filename>interfaces</filename> to the + To better understand this, consider an example that customizes a recipe by adding + a BSP-specific configuration file named <filename>interfaces</filename> to the <filename>netbase_5.0.bb</filename> recipe for machine "xyz". Do the following: <orderedlist> - <listitem><para>Edit the <filename>netbase_4.47.bbappend</filename> file so that it + <listitem><para>Edit the <filename>netbase_4.47.bbappend</filename> file so that it contains the following: <literallayout class='monospaced'> FILESEXTRAPATHS_prepend := "${THISDIR}/files:" PRINC := "${@int(PRINC) + 2}" </literallayout></para></listitem> - <listitem><para>Create and place the new <filename>interfaces</filename> + <listitem><para>Create and place the new <filename>interfaces</filename> configuration file in the BSP's layer here: <literallayout class='monospaced'> meta-xyz/recipes-core/netbase/files/xyz/interfaces @@ -909,24 +909,24 @@ <para> In some cases, a BSP contains separately licensed Intellectual Property (IP) 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 OpenEmbedded build system can then build and + 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 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. </para> <para> - You could find that some separately licensed components that are essential + You could find that some separately licensed components that are essential for normal operation of the system might not have an unencumbered (or free) substitute. Without these essential components, the system would be non-functional. - Then again, you might find that other licensed components that are simply - 'good-to-have' or purely elective do have an unencumbered, free replacement + Then again, you might find that other licensed components that are simply + 'good-to-have' or purely elective do have an unencumbered, free replacement component that you can use rather than agreeing to the separately licensed component. - Even for components essential to the system, you might find an unencumbered component - that is not identical but will work as a less-capable version of the + Even for components essential to the system, you might find an unencumbered component + that is not identical but will work as a less-capable version of the licensed version in the BSP recipe. </para> @@ -935,14 +935,14 @@ maintain the system's functionality, the Yocto Project website's <ulink url='&YOCTO_HOME_URL;/download/all?keys=&download_type=1&download_version='>BSP Download Page</ulink> makes available de-featured BSPs - that are completely free of any IP encumbrances. + that are completely free of any IP encumbrances. For these cases, you can use the substitution directly and - without any further licensing requirements. + without any further licensing requirements. If present, these fully de-featured BSPs are named appropriately different as compared to the names of the respective - encumbered BSPs. + encumbered BSPs. If available, these substitutions are your - simplest and most preferred options. + simplest and most preferred options. Use of these substitutions of course assumes the resulting functionality meets system requirements. </para> @@ -953,23 +953,23 @@ version. </para> - <para> - A couple different methods exist within the OpenEmbedded build system to - satisfy the licensing requirements for an encumbered BSP. + <para> + 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 recipes that have commercial or other types of - specially-licensed packages:</emphasis> - For each of those recipes, you can + specially-licensed packages:</emphasis> + For each of those recipes, you can specify a matching license string in a - <filename>local.conf</filename> variable named + <filename>local.conf</filename> variable named <filename>LICENSE_FLAGS_WHITELIST</filename>. Specifying the matching license string signifies that you agree to the license. - Thus, the build system can build the corresponding recipe and include + Thus, the build system can build the corresponding recipe and include the component in the image. - See the - "<ulink url='&YOCTO_DOCS_REF_URL;#enabling-commercially-licensed-recipes'>Enabling + See the + "<ulink url='&YOCTO_DOCS_REF_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" section in the Yocto Project Reference Manual for details on how to use these variables.</para> <para>If you build as you normally would, without @@ -977,15 +977,15 @@ <filename>LICENSE_FLAGS_WHITELIST</filename>, the build stops and provides you with the list of recipes that you have tried to include in the image that need entries in - the <filename>LICENSE_FLAGS_WHITELIST</filename>. + the <filename>LICENSE_FLAGS_WHITELIST</filename>. Once you enter the appropriate license flags into the whitelist, restart the build to continue where it left off. During the build, the prompt will not appear again since you have satisfied the requirement.</para> <para>Once the appropriate license flags are on the white list - in the <filename>LICENSE_FLAGS_WHITELIST</filename> variable, you + in the <filename>LICENSE_FLAGS_WHITELIST</filename> variable, you can build the encumbered image with no change at all - to the normal build process.</para></listitem> + to the normal build process.</para></listitem> <listitem><para><emphasis>Get a pre-built version of the BSP:</emphasis> You can get this type of BSP by visiting the Yocto Project website's <ulink url='&YOCTO_HOME_URL;/download'>Download</ulink> @@ -993,11 +993,11 @@ You can download BSP tarballs that contain proprietary components after agreeing to the licensing requirements of each of the individually encumbered - packages as part of the download process. + packages as part of the download process. Obtaining the BSP this way allows you to access an encumbered image immediately after agreeing to the click-through license agreements presented by the - website. + website. Note that if you want to build the image yourself using the recipes contained within the BSP tarball, you will still need to create an @@ -1010,11 +1010,11 @@ Pre-compiled images are bundled with a time-limited kernel that runs for a predetermined amount of time (10 days) before it forces - the system to reboot. + the system to reboot. This limitation is meant to discourage direct redistribution of the image. You must eventually rebuild the image if you want to remove this restriction. - </note> + </note> </section> <section id='using-the-yocto-projects-bsp-tools'> @@ -1022,16 +1022,16 @@ <para> 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 + 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 metadata file. These tools are <filename>yocto-bsp</filename> and <filename>yocto-kernel</filename>, - respectively. + respectively. </para> <para> - The following sections describe the common location and help features as well - as provide details for the + The following sections describe the common location and help features as well + as provide details for the <filename>yocto-bsp</filename> and <filename>yocto-kernel</filename> tools. </para> @@ -1039,7 +1039,7 @@ <title>Common Features</title> <para> - Designed to have a command interface somewhat like + Designed to have a command interface somewhat like <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>, each tool is structured as a set of sub-commands under a top-level command. @@ -1050,9 +1050,9 @@ </para> <para> - Both tools reside in the <filename>scripts/</filename> subdirectory + Both tools reside in the <filename>scripts/</filename> subdirectory of the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. - Consequently, to use the scripts, you must <filename>source</filename> the + Consequently, to use the scripts, you must <filename>source</filename> the environment just as you would when invoking a build: <literallayout class='monospaced'> $ source oe-init-build-env [build_dir] @@ -1067,7 +1067,7 @@ switch: <literallayout class='monospaced'> $ yocto-bsp help - Usage: + Usage: Create a customized Yocto BSP layer. @@ -1088,12 +1088,12 @@ </para> <para> - Similarly, entering just the name of a sub-command shows the detailed usage + Similarly, entering just the name of a sub-command shows the detailed usage for that sub-command: <literallayout class='monospaced'> $ yocto-bsp create - Usage: + Usage: Create a new Yocto BSP @@ -1111,7 +1111,7 @@ </para> <para> - For any sub-command, you can also use the word 'help' just before the + For any sub-command, you can also use the word 'help' just before the sub-command to get more extensive documentation: <literallayout class='monospaced'> $ yocto-bsp help create @@ -1141,11 +1141,11 @@ </para> <para> - Now that you know where these two commands reside and how to access information - on them, you should find it relatively straightforward to discover the commands + Now that you know where these two commands reside and how to access information + on them, you should find it relatively straightforward to discover the commands necessary to create a BSP and perform basic kernel maintenance on that BSP using the tools. - The next sections provide a concrete starting point to expand on a few points that + The next sections provide a concrete starting point to expand on a few points that might not be immediately obvious or that could use further explanation. </para> </section> @@ -1155,10 +1155,10 @@ <title>Creating a new BSP Layer Using the yocto-bsp Script</title> <para> - The <filename>yocto-bsp</filename> script creates a new - <link linkend='bsp-layers'>BSP layer</link> for any architecture supported + The <filename>yocto-bsp</filename> script creates a new + <link linkend='bsp-layers'>BSP layer</link> for any architecture supported by the Yocto Project, as well as QEMU versions of the same. - The default mode of the script's operation is to prompt you for information needed + The default mode of the script's operation is to prompt you for information needed to generate the BSP layer. For the current set of BSPs, the script prompts you for various important parameters such as: @@ -1174,11 +1174,11 @@ </para> <para> - You use the <filename>yocto-bsp create</filename> sub-command to create - a new BSP layer. - This command requires you to specify a particular kernel architecture + You use the <filename>yocto-bsp create</filename> sub-command to create + a new BSP layer. + This command requires you to specify a particular kernel architecture (<filename>karch</filename>) on which to base the BSP. - Assuming you have sourced the environment, you can use the + Assuming you have sourced the environment, you can use the <filename>yocto-bsp list karch</filename> sub-command to list the architectures available for BSP creation as follows: <literallayout class='monospaced'> @@ -1194,7 +1194,7 @@ </para> <para> - The remainder of this section presents an example that uses + The remainder of this section presents an example that uses <filename>myarm</filename> as the machine name and <filename>qemu</filename> as the machine architecture. Of the available architectures, <filename>qemu</filename> is the only architecture @@ -1206,14 +1206,14 @@ </para> <para> - As the <filename>yocto-bsp create</filename> command runs, default values for + As the <filename>yocto-bsp create</filename> command runs, default values for the prompts appear in brackets. Pressing enter without supplying anything on the command line or pressing enter and providing an invalid response causes the script to accept the default value. Once the script completes, the new <filename>meta-myarm</filename> BSP layer - is created in the current working directory. + is created in the current working directory. This example assumes you have source the &OE_INIT_FILE; and are currently - in the top-level folder of the + in the top-level folder of the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. </para> @@ -1254,47 +1254,47 @@ </literallayout> Let's take a closer look at the example now: <orderedlist> - <listitem><para>For the <filename>qemu</filename> architecture, + <listitem><para>For the <filename>qemu</filename> architecture, the script first prompts you for which emulated architecture to use. In the example, we use the <filename>arm</filename> architecture. </para></listitem> <listitem><para>The script then prompts you for the kernel. - The default 3.4 kernel is acceptable. + The default 3.4 kernel is acceptable. So, the example accepts the default. If you enter 'n', the script prompts you to further enter the kernel you do want to use (e.g. 3.0, 3.2_preempt-rt, and so forth.).</para></listitem> - <listitem><para>Next, the script asks whether you would like to have a new - branch created especially for your BSP in the local - <ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink> + <listitem><para>Next, the script asks whether you would like to have a new + branch created especially for your BSP in the local + <ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink> Git repository . If not, then the script re-uses an existing branch.</para> <para>In this example, the default (or 'yes') is accepted. Thus, a new branch is created for the BSP rather than using a common, shared branch. - The new branch is the branch committed to for any patches you might later add. + The new branch is the branch committed to for any patches you might later add. The reason a new branch is the default is that typically new BSPs do require BSP-specific patches. The tool thus assumes that most of time a new branch is required. </para></listitem> - <listitem><para>Regardless of which choice you make in the previous step, + <listitem><para>Regardless of which choice you make in the previous step, you are now given the opportunity to select a particular machine branch on - which to base your new BSP-specific machine branch - (or to re-use if you had elected to not create a new branch). - Because this example is generating an <filename>arm</filename> BSP, the example + which to base your new BSP-specific machine branch + (or to re-use if you had elected to not create a new branch). + Because this example is generating an <filename>arm</filename> BSP, the example uses <filename>#1</filename> at the prompt, which selects the arm-versatile branch. </para></listitem> - <listitem><para>The remainder of the prompts are routine. + <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 - current working directory of the - <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, + <listitem><para>By default, the script creates the new BSP Layer in the + current working directory of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, which is <filename>poky</filename> in this case. </para></listitem> - </orderedlist> + </orderedlist> </para> <para> - Once the BSP Layer is created, you must add it to your + Once the BSP Layer is created, you must add it to your <filename>bblayers.conf</filename> file. Here is an example: <literallayout class='monospaced'> @@ -1309,11 +1309,11 @@ /usr/local/src/yocto/meta \ /usr/local/src/yocto/meta-yocto \ " - </literallayout> - Adding the layer to this file allows the build system to build the BSP and - the <filename>yocto-kernel</filename> tool to be able to find the layer and + </literallayout> + Adding the layer to this file allows the build system to build the BSP and + the <filename>yocto-kernel</filename> tool to be able to find the layer and other metadata it needs on which to operate. - </para> + </para> </section> <section id='managing-kernel-patches-and-config-items-with-yocto-kernel'> @@ -1331,14 +1331,14 @@ <para> The <filename>yocto-kernel</filename> script allows you to add, remove, and list patches - and kernel config settings to a 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 is to use the <filename>yocto-kernel</filename> built-in help as follows: <literallayout class='monospaced'> $ yocto-kernel - Usage: + Usage: Modify and list Yocto BSP kernel config items and patches. @@ -1364,8 +1364,8 @@ </para> <para> - The <filename>yocto-kernel patch add</filename> sub-command allows you to add a - patch to a BSP. + The <filename>yocto-kernel patch add</filename> sub-command allows you to add a + patch to a BSP. The following example adds two patches to the <filename>myarm</filename> BSP: <literallayout class='monospaced'> $ yocto-kernel patch add myarm ~/test.patch @@ -1381,7 +1381,7 @@ </para> <para> - You can verify patches have been added by using the + You can verify patches have been added by using the <filename>yocto-kernel patch list</filename> sub-command. Here is an example: <literallayout class='monospaced'> @@ -1420,7 +1420,7 @@ <para> In a completely similar way, you can use the <filename>yocto-kernel config add</filename> sub-command to add one or more kernel config item settings to a BSP. - The following commands add a couple of config items to the + The following commands add a couple of config items to the <filename>myarm</filename> BSP: <literallayout class='monospaced'> $ yocto-kernel config add myarm CONFIG_MISC_DEVICES=y @@ -1448,7 +1448,7 @@ </para> <para> - Finally, you can remove one or more config items using the + Finally, you can remove one or more config items using the <filename>yocto-kernel config rm</filename> sub-command in a manner completely analogous to <filename>yocto-kernel patch rm</filename>. </para> |