diff options
| author |   Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-12-07 17:23:56 -0600 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-11 16:15:24 +0000 |
| commit | 72d01bf43da4d6761ee1b5997307c64152ec3517 (patch) | |
| tree | a1b95e8fd3a4489343205eb5f67cb1937efb6f9c /documentation | |
| parent | eb8c9e1494692583f77d83267f78d5d88a79973d (diff) | |
| download | openembedded-core-contrib-72d01bf43da4d6761ee1b5997307c64152ec3517.tar.gz | |
documentation: dev-manual - Removed all trailing whitespace.
(From yocto-docs rev: d117584a589460412a7fc4df15512b0d9c9448c7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 1582 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 96 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual-kernel-appendix-orig.xml | 232 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 1128 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 848 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 238 | ||||
| -rw-r--r-- | documentation/dev-manual/dev-manual.xml | 18 |
7 files changed, 2071 insertions, 2071 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 1e2ddefda0..6c406dad53 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -8,8 +8,8 @@ <para> This chapter describes standard tasks such as adding new software packages, extending or customizing images, and porting work to - new hardware (adding a new machine). - The chapter also describes how to combine multiple + new hardware (adding a new machine). + The chapter also describes how to combine multiple versions of library files into a single image, how to handle a package name alias, and gives advice about how to make changes to the Yocto Project to achieve the best results. </para> @@ -18,8 +18,8 @@ <title>Understanding and Creating Layers</title> <para> - The OpenEmbedded build system supports organizing <link linkend='metadata'>metadata</link> - into multiple layers. + The OpenEmbedded build system supports organizing <link linkend='metadata'>metadata</link> + into multiple layers. Layers allow you to isolate different types of customizations from each other. You might find it tempting to keep everything in one layer when working on a single project. However, the more modular you organize your metadata, the easier it is to cope with future changes. @@ -28,14 +28,14 @@ <para> To illustrate how layers are used to keep things modular, consider machine customizations. These types of customizations typically reside in a BSP Layer. - Furthermore, the machine customizations should be isolated from recipes and metadata that support - a new GUI environment, for example. - This situation gives you a couple of layers: one for the machine configurations, and one for the + Furthermore, the machine customizations should be isolated from recipes and metadata that support + a new GUI environment, for example. + This situation gives you a couple of layers: one for the machine configurations, and one for the GUI environment. - It is important to understand, however, that the BSP layer can still make machine-specific - additions to recipes within the GUI environment layer without polluting the GUI layer itself - with those machine-specific changes. - You can accomplish this through a recipe that is a BitBake append + It is important to understand, however, that the BSP layer can still make machine-specific + additions to recipes within the GUI environment layer without polluting the GUI layer itself + with those machine-specific changes. + You can accomplish this through a recipe that is a BitBake append (<filename>.bbappend</filename>) file, which is described later in this section. </para> @@ -50,17 +50,17 @@ You can easily identify a layer in the Source Directory by its folder name. Folders that are layers begin with the string <filename>meta</filename>. For example, when you set up the <link linkend='source-directory'>Source Directory</link> - structure, you will see several layers: <filename>meta</filename>, - <filename>meta-hob</filename>, <filename>meta-skeleton</filename>, + structure, you will see several layers: <filename>meta</filename>, + <filename>meta-hob</filename>, <filename>meta-skeleton</filename>, <filename>meta-yocto</filename>, and <filename>meta-yocto-bsp</filename>. Each of these folders is a layer. </para> <para> Furthermore, if you set up a local copy of the <filename>meta-intel</filename> Git repository - and then explore that folder, you will discover many BSP layers within the + and then explore that folder, you will discover many BSP layers within the <filename>meta-intel</filename> layer. - For more information on BSP layers, see the + For more information on BSP layers, see the "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" section in the Yocto Project Board Support Package (BSP) Developer's Guide. </para> @@ -73,14 +73,14 @@ It is very easy to create your own layer to use with the OpenEmbedded build system. Follow these general steps to create your layer: <orderedlist> - <listitem><para><emphasis>Check Existing Layers:</emphasis> Before creating a new layer, - you should be sure someone has not already created a layer containing the metadata + <listitem><para><emphasis>Check Existing Layers:</emphasis> Before creating a new layer, + you should be sure someone has not already created a layer containing the metadata you need. You can see the <ulink url='&OE_HOME_URL;/wiki/LayerIndex'><filename>LayerIndex</filename></ulink> - for a list of layers from the OpenEmbedded community that can be used in the + for a list of layers from the OpenEmbedded community that can be used in the Yocto Project.</para></listitem> - <listitem><para><emphasis>Create a Directory:</emphasis> Create the directory + <listitem><para><emphasis>Create a Directory:</emphasis> Create the directory for your layer. Traditionally, prepend the name of the folder with the string <filename>meta</filename>. @@ -92,9 +92,9 @@ </literallayout></para></listitem> <listitem><para><emphasis>Create a Layer Configuration File:</emphasis> Inside your new layer folder, you need to create a <filename>conf/layer.conf</filename> file. - It is easiest to take an existing layer configuration file and copy that to your + It is easiest to take an existing layer configuration file and copy that to your layer's <filename>conf</filename> directory and then modify the file as needed.</para> - <para>The <filename>meta-yocto/conf/layer.conf</filename> file demonstrates the + <para>The <filename>meta-yocto/conf/layer.conf</filename> file demonstrates the required syntax: <literallayout class='monospaced'> # We have a conf and classes directory, add to BBPATH @@ -106,47 +106,47 @@ BBFILE_COLLECTIONS += "yocto" BBFILE_PATTERN_yocto := "^${LAYERDIR}/" - BBFILE_PRIORITY_yocto = "5" + BBFILE_PRIORITY_yocto = "5" </literallayout></para> - <para>In the previous example, the recipes for the layers are added to - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'>BBFILES</ulink></filename>. - The + <para>In the previous example, the recipes for the layers are added to + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILES'>BBFILES</ulink></filename>. + The <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename> - variable is then appended with the layer name. - The - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename> + variable is then appended with the layer name. + The + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PATTERN'>BBFILE_PATTERN</ulink></filename> variable is set to a regular expression and is used to match files from <filename>BBFILES</filename> into a particular layer. - In this case, immediate expansion of - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename> + In this case, immediate expansion of + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename> sets <filename>BBFILE_PATTERN</filename> to the layer's path. - The - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename> - variable then assigns a priority to the layer. + The + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename> + variable then assigns a priority to the layer. Applying priorities is useful in situations where the same package might appear in multiple layers and allows you to choose what layer should take precedence.</para> - <para>Note the use of the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename> + <para>Note the use of the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LAYERDIR'>LAYERDIR</ulink></filename> variable with the immediate expansion operator. The <filename>LAYERDIR</filename> variable expands to the directory of the current layer and - requires the immediate expansion operator so that BitBake does not wait to expand the variable + requires the immediate expansion operator so that BitBake does not wait to expand the variable when it's parsing a different directory.</para> <para>Through the use of the <filename>BBPATH</filename> variable, BitBake locates <filename>.bbclass</filename> files, configuration - files, and files that are included with <filename>include</filename> - and <filename>require</filename> statements. - For these cases, BitBake uses the first file with the matching name found in + files, and files that are included with <filename>include</filename> + and <filename>require</filename> statements. + For these cases, BitBake uses the first file with the matching name found in <filename>BBPATH</filename>. - This is similar to the way the <filename>PATH</filename> variable is used for binaries. + This is similar to the way the <filename>PATH</filename> variable is used for binaries. We recommend, therefore, that you use unique <filename>.bbclass</filename> and configuration file names in your custom layer.</para></listitem> - <listitem><para><emphasis>Add Content:</emphasis> Depending on the type of layer, + <listitem><para><emphasis>Add Content:</emphasis> Depending on the type of layer, add the content. - If the layer adds support for a machine, add the machine configuration in + If the layer adds support for a machine, add the machine configuration in a <filename>conf/machine/</filename> file within the layer. If the layer adds distro policy, add the distro configuration in a <filename>conf/distro/</filename> file with the layer. - If the layer introduces new recipes, put the recipes you need in + If the layer introduces new recipes, put the recipes you need in <filename>recipes-*</filename> subdirectories within the layer. <note>In order to be compliant with the Yocto Project, a layer must contain a <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-readme'>README file.</ulink> @@ -157,45 +157,45 @@ <para> To create layers that are easier to maintain, you should consider the following: <itemizedlist> - <listitem><para>Avoid "overlaying" entire recipes from other layers in your + <listitem><para>Avoid "overlaying" entire recipes from other layers in your configuration. In other words, don't copy an entire recipe into your layer and then modify it. - Use <filename>.bbappend</filename> files to override the parts of the + Use <filename>.bbappend</filename> files to override the parts of the recipe you need to modify.</para></listitem> <listitem><para>Avoid duplicating include files. - Use <filename>.bbappend</filename> files for each recipe that uses an include + Use <filename>.bbappend</filename> files for each recipe that uses an include file. - Or, if you are introducing a new recipe that requires the included file, use the + Or, if you are introducing a new recipe that requires the included file, use the path relative to the original layer directory to refer to the file. For example, use <filename>require recipes-core/somepackage/somefile.inc</filename> - instead of <filename>require somefile.inc</filename>. - If you're finding you have to overlay the include file, it could indicate a + instead of <filename>require somefile.inc</filename>. + If you're finding you have to overlay the include file, it could indicate a deficiency in the include file in the layer to which it originally belongs. If this is the case, you need to address that deficiency instead of overlaying the include file. For example, consider how Qt 4 database support plug-ins are configured. - The Source Directory does not have + The Source Directory does not have MySQL or PostgreSQL, however OpenEmbedded's layer <filename>meta-oe</filename> does. Consequently, <filename>meta-oe</filename> uses <filename>.bbappend</filename> - files to modify the <filename>QT_SQL_DRIVER_FLAGS</filename> variable to enable - the appropriate plugins. - This variable was added to the <filename>qt4.inc</filename> include file in + files to modify the <filename>QT_SQL_DRIVER_FLAGS</filename> variable to enable + the appropriate plugins. + This variable was added to the <filename>qt4.inc</filename> include file in the Source Directory specifically to allow the <filename>meta-oe</filename> layer to be able to control which plugins are built.</para></listitem> - </itemizedlist> + </itemizedlist> </para> <para> We also recommend the following: <itemizedlist> - <listitem><para>Store custom layers in a Git repository that uses the + <listitem><para>Store custom layers in a Git repository that uses the <filename>meta-<layer_name></filename> format.</para></listitem> <listitem><para>Clone the repository alongside other <filename>meta</filename> - directories in the + directories in the <link linkend='source-directory'>Source Directory</link>.</para></listitem> </itemizedlist> - Following these recommendations keeps your Source Directory and + Following these recommendations keeps your Source Directory and its configuration entirely inside the Yocto Project's core base. </para> </section> @@ -205,10 +205,10 @@ <para> Before the OpenEmbedded build system can use your new layer, you need to enable it. - To enable your layer, simply add your layer's path to the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> - variable in your <filename>conf/bblayers.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>. + To enable your layer, simply add your layer's path to the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> + variable in your <filename>conf/bblayers.conf</filename> file, which is found in the + <link linkend='build-directory'>Build Directory</link>. The following example shows how to enable a layer named <filename>meta-mylayer</filename>: <literallayout class='monospaced'> LCONF_VERSION = "6" @@ -226,15 +226,15 @@ BBLAYERS_NON_REMOVABLE ?= " \ $HOME/poky/meta \ $HOME/poky/meta-yocto \ - " + " </literallayout> </para> <para> - BitBake parses each <filename>conf/layer.conf</filename> file as specified in the + BitBake parses each <filename>conf/layer.conf</filename> file as specified in the <filename>BBLAYERS</filename> variable within the <filename>conf/bblayers.conf</filename> file. - During the processing of each <filename>conf/layer.conf</filename> file, BitBake adds the + During the processing of each <filename>conf/layer.conf</filename> file, BitBake adds the recipes, classes and configurations contained within the particular layer to the source directory. </para> @@ -245,43 +245,43 @@ <para> Recipes used to append metadata to other recipes are called BitBake append files. - BitBake append files use the <filename>.bbappend</filename> file type suffix, while - the corresponding recipes to which metadata is being appended use the + BitBake append files use the <filename>.bbappend</filename> file type suffix, while + the corresponding recipes to which metadata is being appended use the <filename>.bb</filename> file type suffix. </para> <para> - A <filename>.bbappend</filename> file allows your layer to make additions or - changes to the content of another layer's recipe without having to copy the other + A <filename>.bbappend</filename> file allows your layer to make additions or + changes to the content of another layer's recipe without having to copy the other recipe into your layer. - Your <filename>.bbappend</filename> file resides in your layer, while the underlying + Your <filename>.bbappend</filename> file resides in your layer, while the underlying <filename>.bb</filename> recipe file to which you are appending metadata resides in a different layer. </para> <para> Append files files must have the same name as the corresponding recipe. - For example, the append file <filename>someapp_&DISTRO;.bbappend</filename> must + For example, the append file <filename>someapp_&DISTRO;.bbappend</filename> must apply to <filename>someapp_&DISTRO;.bb</filename>. This means the original recipe and append file names are version number specific. - If the corresponding recipe is renamed to update to a newer version, the + If the corresponding recipe is renamed to update to a newer version, the underlying <filename>.bbappend</filename> file must be renamed as well. - During the build process, BitBake displays an error on starting if it detects a - <filename>.bbappend</filename> file that does not have a corresponding recipe + During the build process, BitBake displays an error on starting if it detects a + <filename>.bbappend</filename> file that does not have a corresponding recipe with a matching name. </para> <para> - Being able to append information to an existing recipe not only avoids duplication, + Being able to append information to an existing recipe not only avoids duplication, but also automatically applies recipe changes in a different layer to your layer. If you were copying recipes, you would have to manually merge changes as they occur. </para> <para> - As an example, consider the main formfactor recipe and a corresponding formfactor - append file both from the + As an example, consider the main formfactor recipe and a corresponding formfactor + append file both from the <link linkend='source-directory'>Source Directory</link>. - Here is the main formfactor recipe, which is named <filename>formfactor_0.0.bb</filename> and + Here is the main formfactor recipe, which is named <filename>formfactor_0.0.bb</filename> and located in the meta layer at <filename>meta/recipes-bsp/formfactor</filename>: <literallayout class='monospaced'> DESCRIPTION = "Device formfactor information" @@ -306,32 +306,32 @@ fi } </literallayout> - Here is the append file, which is named <filename>formfactor_0.0.bbappend</filename> and is from the + Here is the append file, which is named <filename>formfactor_0.0.bbappend</filename> and is from the Crown Bay BSP Layer named <filename>meta-intel/meta-crownbay</filename>. The file is in <filename>recipes-bsp/formfactor</filename>: <literallayout class='monospaced'> FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" - + PRINC := "${@int(PRINC) + 2}" </literallayout> - This example adds or overrides files in + This example adds or overrides files in <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> - within a <filename>.bbappend</filename> by extending the path BitBake uses to search for files. - The most reliable way to do this is by prepending the + within a <filename>.bbappend</filename> by extending the path BitBake uses to search for files. + The most reliable way to do this is by prepending the <filename>FILESEXTRAPATHS</filename> variable. - For example, if you have your files in a directory that is named the same as your package + For example, if you have your files in a directory that is named the same as your package (<ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>), you can add this directory by adding the following to your <filename>.bbappend</filename> file: <literallayout class='monospaced'> FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" </literallayout> - Using the immediate expansion assignment operator <filename>:=</filename> is important because + Using the immediate expansion assignment operator <filename>:=</filename> is important because of the reference to <filename>THISDIR</filename>. - The trailing colon character is important as it ensures that items in the list remain + The trailing colon character is important as it ensures that items in the list remain colon-separated. <note>BitBake automatically defines the <filename>THISDIR</filename> variable. You should never set this variable yourself. - Using <filename>_prepend</filename> ensures your path will be searched prior to other + Using <filename>_prepend</filename> ensures your path will be searched prior to other paths in the final list. </note> </para> @@ -342,17 +342,17 @@ <para> Each layer is assigned a priority value. - Priority values control which layer takes precedence if there are recipe files with + Priority values control which layer takes precedence if there are recipe files with the same name in multiple layers. For these cases, the recipe file from the layer with a higher priority number taking precedence. - Priority values also affect the order in which multiple <filename>.bbappend</filename> files - for the same recipe are applied. + Priority values also affect the order in which multiple <filename>.bbappend</filename> files + for the same recipe are applied. You can either specify the priority manually, or allow the build system to calculate it based on the layer's dependencies. </para> <para> - To specify the layer's priority manually, use the + To specify the layer's priority manually, use the <ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'><filename>BBFILE_PRIORITY</filename></ulink> variable. For example: @@ -362,10 +362,10 @@ </para> <note> - <para>It is possible for a recipe with a lower version number + <para>It is possible for a recipe with a lower version number <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> in a layer that has a higher priority to take precedence.</para> - <para>Also, the layer priority does not currently affect the precedence order of + <para>Also, the layer priority does not currently affect the precedence order of <filename>.conf</filename> or <filename>.bbclass</filename> files. Future versions of BitBake might address this.</para> </note> @@ -375,9 +375,9 @@ <title>Managing Layers</title> <para> - You can use the BitBake layer management tool to provide a view into the structure of + You can use the BitBake layer management tool to provide a view into the structure of recipes across a multi-layer project. - Being able to generate output that reports on configured layers with their paths and + Being able to generate output that reports on configured layers with their paths and priorities and on <filename>.bbappend</filename> files and their applicable recipes can help to reveal potential problems. </para> @@ -394,11 +394,11 @@ <listitem><para><filename><emphasis>show-layers:</emphasis></filename> Show the current configured layers.</para></listitem> <listitem><para><filename><emphasis>show-recipes:</emphasis></filename> - Lists available recipes and the layers that provide them. + Lists available recipes and the layers that provide them. </para></listitem> <listitem><para><filename><emphasis>show-overlayed:</emphasis></filename> - Lists overlayed recipes. - A recipe is overlayed when a recipe with the same name exists in another layer + Lists overlayed recipes. + A recipe is overlayed when a recipe with the same name exists in another layer that has a higher layer priority. </para></listitem> <listitem><para><filename><emphasis>show-appends:</emphasis></filename> @@ -413,15 +413,15 @@ <itemizedlist> <listitem><para>Non-recipe files (such as patches) are overwritten. The flatten command shows a warning for these files.</para></listitem> - <listitem><para>Anything beyond the normal layer setup has been added to + <listitem><para>Anything beyond the normal layer setup has been added to the <filename>layer.conf</filename> file. Only the lowest priority layer's <filename>layer.conf</filename> is used. </para></listitem> <listitem><para>Overridden and appended items from <filename>.bbappend</filename> files need to be cleaned up. - The contents of each <filename>.bbappend</filename> end up in the + The contents of each <filename>.bbappend</filename> end up in the flattened recipe. - However, if there are appended or changed variable values, you need to tidy + However, if there are appended or changed variable values, you need to tidy these up yourself. Consider the following example. Here, the <filename>bitbake-layers</filename> command adds the line @@ -457,7 +457,7 @@ <title>Customizing Images</title> <para> - You can customize images to satisfy particular requirements. + You can customize images to satisfy particular requirements. This section describes several methods and provides guidelines for each. </para> @@ -465,7 +465,7 @@ <title>Customizing Images Using Custom .bb Files</title> <para> - One way to get additional software into an image is to create a custom image. + One way to get additional software into an image is to create a custom image. The following example shows the form for the two lines you need: <literallayout class='monospaced'> IMAGE_INSTALL = "packagegroup-core-x11-base package1 package2" @@ -476,19 +476,19 @@ <para> By creating a custom image, a developer has total control - over the contents of the image. - It is important to use the correct names of packages in the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> - variable. - You must use the OpenEmbedded notation and not the Debian notation for the names + over the contents of the image. + It is important to use the correct names of packages in the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> + variable. + You must use the OpenEmbedded notation and not the Debian notation for the names (e.g. <filename>eglibc-dev</filename> instead of <filename>libc6-dev</filename>). </para> <para> - The other method for creating a custom image is to base it on an existing image. + The other method for creating a custom image is to base it on an existing image. For example, if you want to create an image based on <filename>core-image-sato</filename> - but add the additional package <filename>strace</filename> to the image, - copy the <filename>meta/recipes-sato/images/core-image-sato.bb</filename> to a + but add the additional package <filename>strace</filename> to the image, + copy the <filename>meta/recipes-sato/images/core-image-sato.bb</filename> to a new <filename>.bb</filename> and add the following line to the end of the copy: <literallayout class='monospaced'> IMAGE_INSTALL += "strace" @@ -501,22 +501,22 @@ <para> For complex custom images, the best approach is to create a custom package group recipe - that is used to build the image or images. - A good example of a package group recipe is + that is used to build the image or images. + A good example of a package group recipe is <filename>meta/recipes-core/packagegroups/packagegroup-core-boot.bb</filename>. - The - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> + The + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> variable lists the package group packages you wish to produce. <filename>inherit packagegroup</filename> sets appropriate default values and automatically adds <filename>-dev</filename> and <filename>-dbg</filename> complementary - packages for every package specified in <filename>PACKAGES</filename>. + packages for every package specified in <filename>PACKAGES</filename>. Note that the inherit line should be towards the top of the recipe, certainly before you set <filename>PACKAGES</filename>. - For each package you specify in <filename>PACKAGES</filename>, you can use + For each package you specify in <filename>PACKAGES</filename>, you can use <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'>RDEPENDS</ulink></filename> - and - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> - entries to provide a list of packages the parent task package should contain. + and + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'>RRECOMMENDS</ulink></filename> + entries to provide a list of packages the parent task package should contain. Following is an example: <literallayout class='monospaced'> DESCRIPTION = "My Custom Package Groups" @@ -546,44 +546,44 @@ <para> In the previous example, two package group packages are created with their dependencies and their - recommended package dependencies listed: <filename>packagegroup-custom-apps</filename>, and - <filename>packagegroup-custom-tools</filename>. - To build an image using these package group packages, you need to add - <filename>packagegroup-custom-apps</filename> and/or - <filename>packagegroup-custom-tools</filename> to + recommended package dependencies listed: <filename>packagegroup-custom-apps</filename>, and + <filename>packagegroup-custom-tools</filename>. + To build an image using these package group packages, you need to add + <filename>packagegroup-custom-apps</filename> and/or + <filename>packagegroup-custom-tools</filename> to <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename>. For other forms of image dependencies see the other areas of this section. </para> </section> <section id='usingpoky-extend-customimage-imagefeatures'> - <title>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and + <title>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></title> <para> - Ultimately users might want to add extra image features to the set by using the + Ultimately users might want to add extra image features to the set by using the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> - variable. - To create these features, the best reference is - <filename>meta/classes/core-image.bbclass</filename>, which shows how this is - achieved. - In summary, the file looks at the contents of the + variable. + To create these features, the best reference is + <filename>meta/classes/core-image.bbclass</filename>, which shows how this is + achieved. + In summary, the file looks at the contents of the <filename>IMAGE_FEATURES</filename> - variable and then maps that into a set of tasks or packages. - Based on this information, the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename> - variable is generated automatically. - Users can add extra features by extending the class or creating a custom class for use + variable and then maps that into a set of tasks or packages. + Based on this information, the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename> + variable is generated automatically. + Users can add extra features by extending the class or creating a custom class for use with specialized image <filename>.bb</filename> files. - You can also add more features by configuring the + You can also add more features by configuring the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> variable in the <filename>local.conf</filename> file found in the Source Directory located in the Build Directory. </para> <para> - The Yocto Project ships with two SSH servers you can use in your images: - Dropbear and OpenSSH. + The Yocto Project ships with two SSH servers you can use in your images: + Dropbear and OpenSSH. Dropbear is a minimal SSH server appropriate for resource-constrained environments, while OpenSSH is a well-known standard SSH server implementation. By default, the <filename>core-image-sato</filename> image is configured to use Dropbear. @@ -591,7 +591,7 @@ images both include OpenSSH. The <filename>core-image-minimal</filename> image does not contain an SSH server. To change these defaults, edit the <filename>IMAGE_FEATURES</filename> variable - so that it sets the image you are working with to include + so that it sets the image you are working with to include <filename>ssh-server-dropbear</filename> or <filename>ssh-server-openssh</filename>. </para> </section> @@ -601,16 +601,16 @@ <para> It is possible to customize image contents by using variables from your - local configuration in your <filename>conf/local.conf</filename> file. - Because it is limited to local use, this method generally only allows you to + local configuration in your <filename>conf/local.conf</filename> file. + Because it is limited to local use, this method generally only allows you to add packages and is not as flexible as creating your own customized image. - When you add packages using local variables this way, you need to realize that + When you add packages using local variables this way, you need to realize that these variable changes affect all images at the same time and might not be what you require. </para> <para> - The simplest way to add extra packages to all images is by using the + The simplest way to add extra packages to all images is by using the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'>IMAGE_INSTALL</ulink></filename> variable with the <filename>_append</filename> operator: <literallayout class='monospaced'> @@ -624,10 +624,10 @@ </para> <para> - Furthermore, you must use <filename>_append</filename> instead of the <filename>+=</filename> - operator if you want to avoid ordering issues. - The reason for this is because doing so unconditionally appends to the variable and - avoids ordering problems due to the variable being set in image recipes and + Furthermore, you must use <filename>_append</filename> instead of the <filename>+=</filename> + operator if you want to avoid ordering issues. + The reason for this is because doing so unconditionally appends to the variable and + avoids ordering problems due to the variable being set in image recipes and <filename>.bbclass</filename> files with operators like <filename>?=</filename>. Using <filename>_append</filename> ensures the operation takes affect. </para> @@ -645,8 +645,8 @@ </para> <para> - You can add packages using a similar approach through the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'>CORE_IMAGE_EXTRA_INSTALL</ulink></filename> + You can add packages using a similar approach through the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CORE_IMAGE_EXTRA_INSTALL'>CORE_IMAGE_EXTRA_INSTALL</ulink></filename> variable. If you use this variable, only <filename>core-image-*</filename> images are affected. </para> @@ -657,27 +657,27 @@ <title>Adding a Package</title> <para> - To add a package you need to write a recipe for it. + To add a package you need to write a recipe for it. Writing a recipe means creating a <filename>.bb</filename> file that sets some variables. For information on variables that are useful for recipes and for information about recipe naming - issues, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#ref-varlocality-recipe-required'>Required</ulink>" + issues, see the + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-varlocality-recipe-required'>Required</ulink>" section of the Yocto Project Reference Manual. </para> <para> Before writing a recipe from scratch, it is often useful to check - whether someone else has written one already. + whether someone else has written one already. OpenEmbedded is a good place to look as it has a wider scope and range of packages. - Because the Yocto Project aims to be compatible with OpenEmbedded, most recipes + Because the Yocto Project aims to be compatible with OpenEmbedded, most recipes you find there should work for you. </para> <para> For new packages, the simplest way to add a recipe is to base it on a similar - pre-existing recipe. - The sections that follow provide some examples that show how to add standard + pre-existing recipe. + The sections that follow provide some examples that show how to add standard types of packages. </para> @@ -685,16 +685,16 @@ <title>Single .c File Package (Hello World!)</title> <para> - Building an application from a single file that is stored locally (e.g. under - <filename>files/</filename>) requires a recipe that has the file listed in - the + Building an application from a single file that is stored locally (e.g. under + <filename>files/</filename>) requires a recipe that has the file listed in + the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> - variable. + variable. Additionally, you need to manually write the <filename>do_compile</filename> and <filename>do_install</filename> tasks. - The <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> - variable defines the - directory containing the source code, which is set to + The <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> + variable defines the + directory containing the source code, which is set to <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'> WORKDIR</ulink></filename> in this case - the directory BitBake uses for the build. <literallayout class='monospaced'> @@ -721,7 +721,7 @@ <para> By default, the <filename>helloworld</filename>, <filename>helloworld-dbg</filename>, - and <filename>helloworld-dev</filename> packages are built. + and <filename>helloworld-dev</filename> packages are built. For information on how to customize the packaging process, see the "<link linkend='splitting-an-application-into-multiple-packages'>Splitting an Application into Multiple Packages</link>" section. @@ -731,15 +731,15 @@ <section id='usingpoky-extend-addpkg-autotools'> <title>Autotooled Package</title> <para> - Applications that use Autotools such as <filename>autoconf</filename> and - <filename>automake</filename> require a recipe that has a source archive listed in - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> and + Applications that use Autotools such as <filename>autoconf</filename> and + <filename>automake</filename> require a recipe that has a source archive listed in + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> and also inherits Autotools, which instructs BitBake to use the <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps needed to build an Autotool-based application. - The result of the build is automatically packaged. - And, if the application uses NLS for localization, packages with local information are - generated (one package per language). + The result of the build is automatically packaged. + And, if the application uses NLS for localization, packages with local information are + generated (one package per language). Following is one example: (<filename>hello_2.3.bb</filename>) <literallayout class='monospaced'> DESCRIPTION = "GNU Helloworld application" @@ -755,10 +755,10 @@ </para> <para> - The variable - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> + The variable + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</ulink></filename> is used to track source license changes as described in the - "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Changes</ulink>" section. + "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Changes</ulink>" section. You can quickly create Autotool-based recipes in a manner similar to the previous example. </para> </section> @@ -768,22 +768,22 @@ <para> Applications that use GNU <filename>make</filename> also require a recipe that has - the source archive listed in - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>. - You do not need to add a <filename>do_compile</filename> step since by default BitBake - starts the <filename>make</filename> command to compile the application. - If you need additional <filename>make</filename> options you should store them in the + the source archive listed in + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>. + You do not need to add a <filename>do_compile</filename> step since by default BitBake + starts the <filename>make</filename> command to compile the application. + If you need additional <filename>make</filename> options you should store them in the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OEMAKE'>EXTRA_OEMAKE</ulink></filename> variable. - BitBake passes these options into the <filename>make</filename> GNU invocation. + BitBake passes these options into the <filename>make</filename> GNU invocation. Note that a <filename>do_install</filename> task is still required. - Otherwise, BitBake runs an empty <filename>do_install</filename> task by default. + Otherwise, BitBake runs an empty <filename>do_install</filename> task by default. </para> <para> Some applications might require extra parameters to be passed to the compiler. - For example, the application might need an additional header path. - You can accomplish this by adding to the + For example, the application might need an additional header path. + You can accomplish this by adding to the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink></filename> variable. The following example shows this: <literallayout class='monospaced'> @@ -829,20 +829,20 @@ <para> If your sources are available as a tarball instead of a Git repository, you - will need to provide the URL to the tarball as well as an + will need to provide the URL to the tarball as well as an <filename>md5</filename> or <filename>sha256</filename> sum of - the download. + the download. Here is an example: <literallayout class='monospaced'> SRC_URI="ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-1.4.9.tar.bz2" SRC_URI[md5sum]="82b8e714b90674896570968f70ca778b" </literallayout> - You can generate the <filename>md5</filename> or <filename>sha256</filename> sums + You can generate the <filename>md5</filename> or <filename>sha256</filename> sums by using the <filename>md5sum</filename> or <filename>sha256sum</filename> commands - with the target file as the only argument. + with the target file as the only argument. Here is an example: <literallayout class='monospaced'> - $ md5sum mtd-utils-1.4.9.tar.bz2 + $ md5sum mtd-utils-1.4.9.tar.bz2 82b8e714b90674896570968f70ca778b mtd-utils-1.4.9.tar.bz2 </literallayout> </para> @@ -851,17 +851,17 @@ <section id='splitting-an-application-into-multiple-packages'> <title>Splitting an Application into Multiple Packages</title> - <para> - You can use the variables - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> and - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink></filename> + <para> + You can use the variables + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink></filename> and + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink></filename> to split an application into multiple packages. </para> <para> - Following is an example that uses the <filename>libXpm</filename> recipe. - By default, this recipe generates a single package that contains the library along - with a few binaries. + Following is an example that uses the <filename>libXpm</filename> recipe. + By default, this recipe generates a single package that contains the library along + with a few binaries. You can modify the recipe to split the binaries into separate packages: <literallayout class='monospaced'> require xorg-lib-common.inc @@ -883,19 +883,19 @@ <para> In the previous example, we want to ship the <filename>sxpm</filename> - and <filename>cxpm</filename> binaries in separate packages. - Since <filename>bindir</filename> would be packaged into the main - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> - package by default, we prepend the + and <filename>cxpm</filename> binaries in separate packages. + Since <filename>bindir</filename> would be packaged into the main + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> + package by default, we prepend the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'>PACKAGES</ulink> - </filename> variable so additional package names are added to the start of list. - This results in the extra + </filename> variable so additional package names are added to the start of list. + This results in the extra <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'>FILES</ulink>_*</filename> variables then containing information that define which files and - directories go into which packages. + directories go into which packages. Files included by earlier packages are skipped by latter packages. - Thus, the main - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> package + Thus, the main + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> package does not include the above listed files. </para> </section> @@ -903,25 +903,25 @@ <section id='including-static-library-files'> <title>Including Static Library Files</title> - <para> + <para> If you are building a library and the library offers static linking, you can control - which static library files (<filename>*.a</filename> files) get included in the - built library. + which static library files (<filename>*.a</filename> files) get included in the + built library. </para> <para> The <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink> and <ulink url='&YOCTO_DOCS_REF_URL;#var-FILES'><filename>FILES_*</filename></ulink> - variables in the + variables in the <filename>meta/conf/bitbake.conf</filename> configuration file define how files installed by the <filename>do_install</filename> task are packaged. - By default, the <filename>PACKAGES</filename> variable contains + By default, the <filename>PACKAGES</filename> variable contains <filename>${PN}-staticdev</filename>, which includes all static library files. <note> - Previously released versions of the Yocto Project defined the static library files + Previously released versions of the Yocto Project defined the static library files through <filename>${PN}-dev</filename>. </note> - Following, is part of the BitBake configuration file. + Following, is part of the BitBake configuration file. You can see where the static library files are defined: <literallayout class='monospaced'> PACKAGES = "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev ${PN}-staticdev ${PN}-locale" @@ -940,14 +940,14 @@ FILES_${PN}-doc = "${docdir} ${mandir} ${infodir} ${datadir}/gtk-doc \ ${datadir}/gnome/help" SECTION_${PN}-doc = "doc" - + FILES_${PN}-dev = "${includedir} ${libdir}/lib*${SOLIBSDEV} ${libdir}/*.la \ ${libdir}/*.o ${libdir}/pkgconfig ${datadir}/pkgconfig \ ${datadir}/aclocal ${base_libdir}/*.o" SECTION_${PN}-dev = "devel" ALLOW_EMPTY_${PN}-dev = "1" RDEPENDS_${PN}-dev = "${PN} (= ${EXTENDPKGV})" - + FILES_${PN}-staticdev = "${libdir}/*.a ${base_libdir}/*.a" SECTION_${PN}-staticdev = "devel" RDEPENDS_${PN}-staticdev = "${PN}-dev (= ${EXTENDPKGV})" @@ -960,10 +960,10 @@ <para> To add a post-installation script to a package, add a <filename>pkg_postinst_PACKAGENAME() - </filename> function to the <filename>.bb</filename> file and use - <filename>PACKAGENAME</filename> as the name of the package you want to attach to the + </filename> function to the <filename>.bb</filename> file and use + <filename>PACKAGENAME</filename> as the name of the package you want to attach to the <filename>postinst</filename> script. - Normally + Normally <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'>PN</ulink></filename> can be used, which automatically expands to <filename>PACKAGENAME</filename>. A post-installation function has the following structure: @@ -976,18 +976,18 @@ </para> <para> - The script defined in the post-installation function is called when the - root filesystem is created. - If the script succeeds, the package is marked as installed. + The script defined in the post-installation function is called when the + root filesystem is created. + If the script succeeds, the package is marked as installed. If the script fails, the package is marked as unpacked and the script is executed when the image boots again. </para> <para> Sometimes it is necessary for the execution of a post-installation - script to be delayed until the first boot. - For example, the script might need to be executed on the device itself. - To delay script execution until boot time, use the following structure in the + script to be delayed until the first boot. + For example, the script might need to be executed on the device itself. + To delay script execution until boot time, use the following structure in the post-installation script: <literallayout class='monospaced'> pkg_postinst_PACKAGENAME () { @@ -1002,11 +1002,11 @@ </para> <para> - The previous example delays execution until the image boots again because the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'>D</ulink></filename> + The previous example delays execution until the image boots again because the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-D'>D</ulink></filename> variable points to the directory containing the image when the root filesystem is created at build time but - is unset when executed on the first boot. + is unset when executed on the first boot. </para> </section> </section> @@ -1015,19 +1015,19 @@ <title>Adding a New Machine</title> <para> - Adding a new machine to the Yocto Project is a straightforward process. + Adding a new machine to the Yocto Project is a straightforward process. This section provides information that gives you an idea of the changes you must make. - The information covers adding machines similar to those the Yocto Project already supports. - Although well within the capabilities of the Yocto Project, adding a totally new architecture - might require - changes to <filename>gcc/eglibc</filename> and to the site information, which is + The information covers adding machines similar to those the Yocto Project already supports. + Although well within the capabilities of the Yocto Project, adding a totally new architecture + might require + changes to <filename>gcc/eglibc</filename> and to the site information, which is beyond the scope of this manual. </para> <para> - For a complete example that shows how to add a new machine, - see the - "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" + For a complete example that shows how to add a new machine, + see the + "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" in the Yocto Project Board Support Package (BSP) Developer's Guide. </para> @@ -1053,7 +1053,7 @@ </itemizedlist> </para> - <para> + <para> You might also need these variables: <itemizedlist> <listitem><para><filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SERIAL_CONSOLE'> @@ -1065,9 +1065,9 @@ </itemizedlist> </para> - <para> - You can find full details on these variables in the reference section. - You can leverage many existing machine <filename>.conf</filename> files from + <para> + You can find full details on these variables in the reference section. + You can leverage many existing machine <filename>.conf</filename> files from <filename>meta/conf/machine/</filename>. </para> </section> @@ -1076,37 +1076,37 @@ <title>Adding a Kernel for the Machine</title> <para> - The OpenEmbedded build system needs to be able to build a kernel for the machine. - You need to either create a new kernel recipe for this machine, or extend an - existing recipe. - You can find several kernel examples in the + The OpenEmbedded build system needs to be able to build a kernel for the machine. + You need to either create a new kernel recipe for this machine, or extend an + existing recipe. + You can find several kernel examples in the Source Directory at <filename>meta/recipes-kernel/linux</filename> that you can use as references. </para> <para> - If you are creating a new recipe, normal recipe-writing rules apply for setting - up a - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>. - Thus, you need to specify any necessary patches and set - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> to point at the source code. - You need to create a <filename>configure</filename> task that configures the + If you are creating a new recipe, normal recipe-writing rules apply for setting + up a + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename>. + Thus, you need to specify any necessary patches and set + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> to point at the source code. + You need to create a <filename>configure</filename> task that configures the unpacked kernel with a defconfig. You can do this by using a <filename>make defconfig</filename> command or, - more commonly, by copying in a suitable <filename>defconfig</filename> file and and then running - <filename>make oldconfig</filename>. - By making use of <filename>inherit kernel</filename> and potentially some of the - <filename>linux-*.inc</filename> files, most other functionality is + more commonly, by copying in a suitable <filename>defconfig</filename> file and and then running + <filename>make oldconfig</filename>. + By making use of <filename>inherit kernel</filename> and potentially some of the + <filename>linux-*.inc</filename> files, most other functionality is centralized and the the defaults of the class normally work well. </para> <para> - If you are extending an existing kernel, it is usually a matter of adding a + If you are extending an existing kernel, it is usually a matter of adding a suitable defconfig file. The file needs to be added into a location similar to defconfig files - used for other machines in a given kernel. - A possible way to do this is by listing the file in the - <filename>SRC_URI</filename> and adding the machine to the expression in + used for other machines in a given kernel. + A possible way to do this is by listing the file in the + <filename>SRC_URI</filename> and adding the machine to the expression in <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</ulink></filename>: <literallayout class='monospaced'> COMPATIBLE_MACHINE = '(qemux86|qemumips)' @@ -1118,25 +1118,25 @@ <title>Adding a Formfactor Configuration File</title> <para> - A formfactor configuration file provides information about the - target hardware for which the image is being built and information that - the build system cannot obtain from other sources such as the kernel. - Some examples of information contained in a formfactor configuration file include - framebuffer orientation, whether or not the system has a keyboard, - the positioning of the keyboard in relation to the screen, and + A formfactor configuration file provides information about the + target hardware for which the image is being built and information that + the build system cannot obtain from other sources such as the kernel. + Some examples of information contained in a formfactor configuration file include + framebuffer orientation, whether or not the system has a keyboard, + the positioning of the keyboard in relation to the screen, and the screen resolution. </para> <para> - The build system uses reasonable defaults in most cases, but if customization is - necessary you need to create a <filename>machconfig</filename> file + The build system uses reasonable defaults in most cases, but if customization is + necessary you need to create a <filename>machconfig</filename> file in the <filename>meta/recipes-bsp/formfactor/files</filename> directory. - This directory contains directories for specific machines such as + This directory contains directories for specific machines such as <filename>qemuarm</filename> and <filename>qemux86</filename>. - For information about the settings available and the defaults, see the + For information about the settings available and the defaults, see the <filename>meta/recipes-bsp/formfactor/files/config</filename> file found in the - same area. + same area. Following is an example for qemuarm: <literallayout class='monospaced'> HAVE_TOUCHSCREEN=1 @@ -1160,8 +1160,8 @@ <para> The build system offers the ability to build libraries with different target optimizations or architecture formats and combine these together - into one system image. - You can link different binaries in the image + into one system image. + You can link different binaries in the image against the different libraries as needed for specific use cases. This feature is called "Multilib." </para> @@ -1175,17 +1175,17 @@ <para> While the Multilib feature is most commonly used for 32 and 64-bit differences, - the approach the build system uses facilitates different target optimizations. + the approach the build system uses facilitates different target optimizations. You could compile some binaries to use one set of libraries and other binaries to use other different sets of libraries. - The libraries could differ in architecture, compiler options, or other + The libraries could differ in architecture, compiler options, or other optimizations. </para> <para> - This section overviews the Multilib process only. - For more details on how to implement Multilib, see the - <ulink url='&YOCTO_WIKI_URL;/wiki/Multilib'>Multilib</ulink> wiki + This section overviews the Multilib process only. + For more details on how to implement Multilib, see the + <ulink url='&YOCTO_WIKI_URL;/wiki/Multilib'>Multilib</ulink> wiki page. </para> @@ -1200,31 +1200,31 @@ <para> In order to enable Multilib, you first need to ensure your recipe is - extended to support multiple libraries. + extended to support multiple libraries. Many standard recipes are already extended and support multiple libraries. You can check in the <filename>meta/conf/multilib.conf</filename> - configuration file in the Source Directory to see how this is - done using the + configuration file in the Source Directory to see how this is + done using the <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> variable. Eventually, all recipes will be covered and this list will be unneeded. </para> - + <para> For the most part, the Multilib class extension works automatically to extend the package name from <filename>${PN}</filename> to <filename>${MLPREFIX}${PN}</filename>, where <filename>MLPREFIX</filename> - is the particular multilib (e.g. "lib32-" or "lib64-"). - Standard variables such as - <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>, + is the particular multilib (e.g. "lib32-" or "lib64-"). + Standard variables such as + <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>, - <filename>RPROVIDES</filename>, + <filename>RPROVIDES</filename>, <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES'><filename>PACKAGES</filename></ulink>, and <filename>PACKAGES_DYNAMIC</filename> are automatically extended by the system. - If you are extending any manual code in the recipe, you can use the - <filename>${MLPREFIX}</filename> variable to ensure those names are extended - correctly. + If you are extending any manual code in the recipe, you can use the + <filename>${MLPREFIX}</filename> variable to ensure those names are extended + correctly. This automatic extension code resides in <filename>multilib.bbclass</filename>. </para> </section> @@ -1234,10 +1234,10 @@ <para> After you have set up the recipes, you need to define the actual - combination of multiple libraries you want to build. + combination of multiple libraries you want to build. You accomplish this through your <filename>local.conf</filename> - configuration file in the - <link linkend='build-directory'>Build Directory</link>. + configuration file in the + <link linkend='build-directory'>Build Directory</link>. An example configuration would be as follows: <literallayout class='monospaced'> MACHINE = "qemux86-64" @@ -1247,7 +1247,7 @@ IMAGE_INSTALL = "lib32-connman" </literallayout> This example enables an - additional library named <filename>lib32</filename> alongside the + additional library named <filename>lib32</filename> alongside the normal target packages. When combining these "lib32" alternatives, the example uses "x86" for tuning. For information on this particular tuning, see @@ -1256,8 +1256,8 @@ <para> The example then includes <filename>lib32-connman</filename> - in all the images, which illustrates one method of including a - multiple library dependency. + in all the images, which illustrates one method of including a + multiple library dependency. You can use a normal image build to include this dependency, for example: <literallayout class='monospaced'> @@ -1275,29 +1275,29 @@ <para> Different packaging systems have different levels of native Multilib - support. - For the RPM Package Management System, the following implementation details + support. + For the RPM Package Management System, the following implementation details exist: <itemizedlist> <listitem><para>A unique architecture is defined for the Multilib packages, - along with creating a unique deploy folder under - <filename>tmp/deploy/rpm</filename> in the - <link linkend='build-directory'>Build Directory</link>. - For example, consider <filename>lib32</filename> in a - <filename>qemux86-64</filename> image. + along with creating a unique deploy folder under + <filename>tmp/deploy/rpm</filename> in the + <link linkend='build-directory'>Build Directory</link>. + For example, consider <filename>lib32</filename> in a + <filename>qemux86-64</filename> image. The possible architectures in the system are "all", "qemux86_64", "lib32_qemux86_64", and "lib32_x86".</para></listitem> - <listitem><para>The <filename>${MLPREFIX}</filename> variable is stripped from + <listitem><para>The <filename>${MLPREFIX}</filename> variable is stripped from <filename>${PN}</filename> during RPM packaging. The naming for a normal RPM package and a Multilib RPM package in a <filename>qemux86-64</filename> system resolves to something similar to - <filename>bash-4.1-r2.x86_64.rpm</filename> and + <filename>bash-4.1-r2.x86_64.rpm</filename> and <filename>bash-4.1.r2.lib32_x86.rpm</filename>, respectively. </para></listitem> - <listitem><para>When installing a Multilib image, the RPM backend first + <listitem><para>When installing a Multilib image, the RPM backend first installs the base image and then installs the Multilib libraries. </para></listitem> - <listitem><para>The build system relies on RPM to resolve the identical files in the + <listitem><para>The build system relies on RPM to resolve the identical files in the two (or more) Multilib packages.</para></listitem> </itemizedlist> </para> @@ -1305,23 +1305,23 @@ <para> For the IPK Package Management System, the following implementation details exist: <itemizedlist> - <listitem><para>The <filename>${MLPREFIX}</filename> is not stripped from + <listitem><para>The <filename>${MLPREFIX}</filename> is not stripped from <filename>${PN}</filename> during IPK packaging. The naming for a normal RPM package and a Multilib IPK package in a - <filename>qemux86-64</filename> system resolves to something like + <filename>qemux86-64</filename> system resolves to something like <filename>bash_4.1-r2.x86_64.ipk</filename> and <filename>lib32-bash_4.1-rw_x86.ipk</filename>, respectively. </para></listitem> - <listitem><para>The IPK deploy folder is not modified with - <filename>${MLPREFIX}</filename> because packages with and without - the Multilib feature can exist in the same folder due to the + <listitem><para>The IPK deploy folder is not modified with + <filename>${MLPREFIX}</filename> because packages with and without + the Multilib feature can exist in the same folder due to the <filename>${PN}</filename> differences.</para></listitem> - <listitem><para>IPK defines a sanity check for Multilib installation + <listitem><para>IPK defines a sanity check for Multilib installation using certain rules for file comparison, overridden, etc. </para></listitem> </itemizedlist> </para> - </section> + </section> </section> <section id='configuring-the-kernel'> @@ -1330,9 +1330,9 @@ <para> Configuring the Yocto Project kernel consists of making sure the <filename>.config</filename> file has all the right information in it for the image you are building. - You can use the <filename>menuconfig</filename> tool and configuration fragments to - make sure your <filename>.config</filename> file is just how you need it. - This section describes how to use <filename>menuconfig</filename>, create and use + You can use the <filename>menuconfig</filename> tool and configuration fragments to + make sure your <filename>.config</filename> file is just how you need it. + This section describes how to use <filename>menuconfig</filename>, create and use configuration fragments, and how to interactively tweak your <filename>.config</filename> file to create the leanest kernel configuration file possible. </para> @@ -1345,7 +1345,7 @@ <section id='using-menuconfig'> <title>Using <filename>menuconfig</filename></title> - + <para> The easiest way to define kernel configurations is to set them through the <filename>menuconfig</filename> tool. @@ -1359,28 +1359,28 @@ To use the <filename>menuconfig</filename> tool in the Yocto Project development environment, you must build the tool using BitBake. Thus, the environment must be set up using the <filename>&OE_INIT_FILE;</filename> - script found in the + script found in the <link linkend='build-directory'>Build Directory</link>. - The following commands build and invoke <filename>menuconfig</filename> assuming the + The following commands build and invoke <filename>menuconfig</filename> assuming the Source Directory top-level folder is <filename>~/poky</filename>: <literallayout class='monospaced'> $ cd ~/poky $ source oe-init-build-env $ bitbake linux-yocto -c menuconfig </literallayout> - Once <filename>menuconfig</filename> comes up, its standard interface allows you to + Once <filename>menuconfig</filename> comes up, its standard interface allows you to interactively examine and configure all the kernel configuration parameters. - After making your changes, simply exit the tool and save your changes to + After making your changes, simply exit the tool and save your changes to create an updated version of the <filename>.config</filename> configuration file. </para> <para> Consider an example that configures the <filename>linux-yocto-3.4</filename> kernel. - The OpenEmbedded build system recognizes this kernel as + The OpenEmbedded build system recognizes this kernel as <filename>linux-yocto</filename>. - Thus, the following commands from the shell in which you previously sourced the - environment initialization script cleans the shared state cache and the + Thus, the following commands from the shell in which you previously sourced the + environment initialization script cleans the shared state cache and the <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink> directory and then builds and launches <filename>menuconfig</filename>: <literallayout class='monospaced'> @@ -1389,11 +1389,11 @@ </para> <para> - Once <filename>menuconfig</filename> launches, you use the interface + Once <filename>menuconfig</filename> launches, you use the interface to navigate through the selections to find the configuration settings in - which you are interested. + which you are interested. For example, consider the <filename>CONFIG_SMP</filename> configuration setting. - You can find it at <filename>Processor Type and Features</filename> under + You can find it at <filename>Processor Type and Features</filename> under the configuration selection <filename>Symmetric Multi-processing Support</filename>. After highlighting the selection, you can use the arrow keys to select or deselect the setting. @@ -1402,24 +1402,24 @@ <para> Saving the selections updates the <filename>.config</filename> configuration file. - This is the file that the OpenEmbedded build system uses to configure the - kernel during the build. - You can find and examine this file in the Build Directory in + This is the file that the OpenEmbedded build system uses to configure the + kernel during the build. + You can find and examine this file in the Build Directory in <filename>tmp/work/</filename>. - The actual <filename>.config</filename> is located in the area where the + The actual <filename>.config</filename> is located in the area where the specific kernel is built. - For example, if you were building a Linux Yocto kernel based on the - Linux 3.4 kernel and you were building a QEMU image targeted for - <filename>x86</filename> architecture, the + For example, if you were building a Linux Yocto kernel based on the + Linux 3.4 kernel and you were building a QEMU image targeted for + <filename>x86</filename> architecture, the <filename>.config</filename> file would be located here: <literallayout class='monospaced'> ~/poky/build/tmp/work/qemux86-poky-linux/linux-yocto-3.4.11+git1+84f... ...656ed30-r1/linux-qemux86-standard-build </literallayout> <note> - The previous example directory is artificially split and many of the characters + The previous example directory is artificially split and many of the characters in the actual filename are omitted in order to make it more readable. - Also, depending on the kernel you are using, the exact pathname + Also, depending on the kernel you are using, the exact pathname for <filename>linux-yocto-3.4...</filename> might differ. </note> </para> @@ -1434,18 +1434,18 @@ </para> <para> - A good method to isolate changed configurations is to use a combination of the + A good method to isolate changed configurations is to use a combination of the <filename>menuconfig</filename> tool and simple shell commands. - Before changing configurations with <filename>menuconfig</filename>, copy the + Before changing configurations with <filename>menuconfig</filename>, copy the existing <filename>.config</filename> and rename it to something else, - use <filename>menuconfig</filename> to make - as many changes an you want and save them, then compare the renamed configuration + use <filename>menuconfig</filename> to make + as many changes an you want and save them, then compare the renamed configuration file against the newly created file. You can use the resulting differences as your base to create configuration fragments to permanently save in your kernel layer. <note> Be sure to make a copy of the <filename>.config</filename> and don't just - rename it. + rename it. The build system needs an existing <filename>.config</filename> from which to work. </note> @@ -1459,13 +1459,13 @@ Configuration fragments are simply kernel options that appear in a file placed where the OpenEmbedded build system can find and apply them. Syntactically, the configuration statement is identical to what would appear - in the <filename>.config</filename> file, which is in the - <link linkend='build-directory'>Build Directory</link> in + in the <filename>.config</filename> file, which is in the + <link linkend='build-directory'>Build Directory</link> in <filename>tmp/work/<arch>-poky-linux/linux-yocto-<release-specific-string>/linux-<arch>-<build-type></filename>. </para> <para> - It is simple to create a configuration fragment. + It is simple to create a configuration fragment. For example, issuing the following from the shell creates a configuration fragment file named <filename>my_smp.cfg</filename> that enables multi-processor support within the kernel: @@ -1480,15 +1480,15 @@ <para> Where do you put your configuration files? - You can place these configuration files in the same area pointed to by + You can place these configuration files in the same area pointed to by <filename>SRC_URI</filename>. - The OpenEmbedded build system will pick up the configuration and add it to the + The OpenEmbedded build system will pick up the configuration and add it to the kernel's configuration. - For example, suppose you had a set of configuration options in a file called - <filename>myconfig.cfg</filename>. - If you put that file inside a directory named <filename>/linux-yocto</filename> - that resides in the same directory as the kernel's append file and then add - a <filename>SRC_URI</filename> statement such as the following to the kernel's append file, + For example, suppose you had a set of configuration options in a file called + <filename>myconfig.cfg</filename>. + If you put that file inside a directory named <filename>/linux-yocto</filename> + that resides in the same directory as the kernel's append file and then add + a <filename>SRC_URI</filename> statement such as the following to the kernel's append file, those configuration options will be picked up and applied when the kernel is built. <literallayout class='monospaced'> SRC_URI += "file://myconfig.cfg" @@ -1496,10 +1496,10 @@ </para> <para> - As mentioned earlier, you can group related configurations into multiple files and + As mentioned earlier, you can group related configurations into multiple files and name them all in the <filename>SRC_URI</filename> statement as well. For example, you could group separate configurations specifically for Ethernet and graphics - into their own files and add those by using a <filename>SRC_URI</filename> statement like the + into their own files and add those by using a <filename>SRC_URI</filename> statement like the following in your append file: <literallayout class='monospaced'> SRC_URI += "file://myconfig.cfg \ @@ -1513,27 +1513,27 @@ <title>Fine-tuning the Kernel Configuration File</title> <para> - You can make sure the <filename>.config</filename> is as lean or efficient as + You can make sure the <filename>.config</filename> is as lean or efficient as possible by reading the output of the kernel configuration fragment audit, noting any issues, making changes to correct the issues, and then repeating. </para> <para> - As part of the kernel build process, the + As part of the kernel build process, the <filename>kernel_configcheck</filename> task runs. - This task validates the kernel configuration by checking the final + This task validates the kernel configuration by checking the final <filename>.config</filename> file against the input files. - During the check, the task produces warning messages for the following + During the check, the task produces warning messages for the following issues: <itemizedlist> - <listitem><para>Requested options that did not make the final + <listitem><para>Requested options that did not make the final <filename>.config</filename> file.</para></listitem> - <listitem><para>Configuration items that appear twice in the same + <listitem><para>Configuration items that appear twice in the same configuration fragment.</para></listitem> <listitem><para>Configuration items tagged as 'required' were overridden. </para></listitem> <listitem><para>A board overrides a non-board specific option.</para></listitem> - <listitem><para>Listed options not valid for the kernel being processed. + <listitem><para>Listed options not valid for the kernel being processed. In other words, the option does not appear anywhere.</para></listitem> </itemizedlist> <note> @@ -1555,31 +1555,31 @@ <listitem><para>Start with a full configuration that you know works - it builds and boots successfully. This configuration file will be your baseline.</para></listitem> - <listitem><para>Separately run the <filename>configme</filename> and + <listitem><para>Separately run the <filename>configme</filename> and <filename>kernel_configcheck</filename> tasks.</para></listitem> - <listitem><para>Take the resulting list of files from the + <listitem><para>Take the resulting list of files from the <filename>kernel_configcheck</filename> task warnings and do the following: <itemizedlist> <listitem><para>Drop values that are redefined in the fragment but do not change the final <filename>.config</filename> file.</para></listitem> - <listitem><para>Analyze and potentially drop values from the - <filename>.config</filename> file that override required + <listitem><para>Analyze and potentially drop values from the + <filename>.config</filename> file that override required configurations.</para></listitem> <listitem><para>Analyze and potentially remove non-board specific options. </para></listitem> <listitem><para>Remove repeated and invalid options.</para></listitem> </itemizedlist></para></listitem> - <listitem><para>After you have worked through the output of the kernel configuration - audit, you can re-run the <filename>configme</filename> - and <filename>kernel_configcheck</filename> tasks to see the results of your - changes. - If you have more issues, you can deal with them as described in the + <listitem><para>After you have worked through the output of the kernel configuration + audit, you can re-run the <filename>configme</filename> + and <filename>kernel_configcheck</filename> tasks to see the results of your + changes. + If you have more issues, you can deal with them as described in the previous step.</para></listitem> - </orderedlist> + </orderedlist> </para> <para> - Iteratively working through steps two through four eventually yields + Iteratively working through steps two through four eventually yields a minimal, streamlined configuration file. Once you have the best <filename>.config</filename>, you can build the Linux Yocto kernel. @@ -1589,35 +1589,35 @@ <section id="patching-the-kernel"> <title>Patching the Kernel</title> - + <para> - Patching the kernel involves changing or adding configurations to an existing kernel, - changing or adding recipes to the kernel that are needed to support specific hardware features, - or even altering the source code itself. + Patching the kernel involves changing or adding configurations to an existing kernel, + changing or adding recipes to the kernel that are needed to support specific hardware features, + or even altering the source code itself. <note> You can use the <filename>yocto-kernel</filename> script found in the <link linkend='source-directory'>Source Directory</link> under <filename>scripts</filename> to manage kernel patches and configuration. - See the "<ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'>Managing kernel Patches and Config Items with yocto-kernel</ulink>" + See the "<ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'>Managing kernel Patches and Config Items with yocto-kernel</ulink>" section in the Yocto Project Board Support Packages (BSP) Developer's Guide for more information.</note> </para> <para> - This example creates a simple patch by adding some QEMU emulator console + This example creates a simple patch by adding some QEMU emulator console output at boot time through <filename>printk</filename> statements in the kernel's <filename>calibrate.c</filename> source code file. - Applying the patch and booting the modified image causes the added + Applying the patch and booting the modified image causes the added messages to appear on the emulator's console. </para> <para> The example assumes a clean build exists for the <filename>qemux86</filename> machine in a Source Directory named <filename>poky</filename>. - Furthermore, the <link linkend='build-directory'>Build Directory</link> is - <filename>build</filename> and is located in <filename>poky</filename> and + Furthermore, the <link linkend='build-directory'>Build Directory</link> is + <filename>build</filename> and is located in <filename>poky</filename> and the kernel is based on the Linux 3.4 kernel. - For general information on how to configure the most efficient build, see the + For general information on how to configure the most efficient build, see the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section in the Yocto Project Quick Start. </para> @@ -1631,13 +1631,13 @@ $cd ~/poky $mkdir meta-mylayer </literallayout> - Creating a directory that follows the Yocto Project layer naming - conventions sets up the layer for your changes. + Creating a directory that follows the Yocto Project layer naming + conventions sets up the layer for your changes. The layer is where you place your configuration files, append - files, and patch files. - To learn more about creating a layer and filling it with the + files, and patch files. + To learn more about creating a layer and filling it with the files you need, see the "<link linkend='understanding-and-creating-layers'>Understanding - and Creating Layers</link>" section. + and Creating Layers</link>" section. </para> </section> @@ -1645,55 +1645,55 @@ <title>Finding the Kernel Source Code</title> <para> - Each time you build a kernel image, the kernel source code is fetched + Each time you build a kernel image, the kernel source code is fetched and unpacked into the following directory: <literallayout class='monospaced'> ${S}/linux </literallayout> - See the "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" - section and the + See the "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" + section and the <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> variable for more information about where source is kept during a build. </para> <para> - For this example, we are going to patch the + For this example, we are going to patch the <filename>init/calibrate.c</filename> file - by adding some simple console <filename>printk</filename> statements that we can + by adding some simple console <filename>printk</filename> statements that we can see when we boot the image using QEMU. </para> - </section> + </section> <section id='creating-the-patch'> <title>Creating the Patch</title> <para> - Two methods exist by which you can create the patch: - <link linkend='using-a-git-workflow'>Git workflow</link> and + Two methods exist by which you can create the patch: + <link linkend='using-a-git-workflow'>Git workflow</link> and <link linkend='using-a-quilt-workflow'>Quilt workflow</link>. - For kernel patches, the Git workflow is more appropriate. - This section assumes the Git workflow and shows the steps specific to + For kernel patches, the Git workflow is more appropriate. + This section assumes the Git workflow and shows the steps specific to this example. <orderedlist> <listitem><para><emphasis>Change the working directory</emphasis>: - Change to where the kernel source code is before making + Change to where the kernel source code is before making your edits to the <filename>calibrate.c</filename> file: <literallayout class='monospaced'> $ cd ~/poky/build/tmp/work/qemux86-poky-linux/linux-yocto-${PV}-${PR}/linux </literallayout> - Because you are working in an established Git repository, + Because you are working in an established Git repository, you must be in this directory in order to commit your changes and create the patch file. - <note>The <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> and + <note>The <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink> and <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> variables - represent the version and revision for the + represent the version and revision for the <filename>linux-yocto</filename> recipe. The <filename>PV</filename> variable includes the Git meta and machine hashes, which make the directory name longer than you might expect. </note></para></listitem> <listitem><para><emphasis>Edit the source file</emphasis>: - Edit the <filename>init/calibrate.c</filename> file to have the + Edit the <filename>init/calibrate.c</filename> file to have the following changes: <literallayout class='monospaced'> void __cpuinit calibrate_delay(void) @@ -1714,7 +1714,7 @@ . </literallayout></para></listitem> <listitem><para><emphasis>Stage and commit your changes</emphasis>: - These Git commands list out the changed file, stage it, and then + These Git commands list out the changed file, stage it, and then commit the file: <literallayout class='monospaced'> $ git status @@ -1723,7 +1723,7 @@ </literallayout></para></listitem> <listitem><para><emphasis>Generate the patch file</emphasis>: This Git command creates the a patch file named - <filename>0001-calibrate-Add-printk-example.patch</filename> + <filename>0001-calibrate-Add-printk-example.patch</filename> in the current directory. <literallayout class='monospaced'> $ git format-patch -1 @@ -1747,8 +1747,8 @@ $ mkdir recipes-kernel/linux $ mkdir recipes-kernel/linux/linux-yocto </literallayout> - The <filename>conf</filename> directory holds your configuration files, while the - <filename>recipes-kernel</filename> directory holds your append file and + The <filename>conf</filename> directory holds your configuration files, while the + <filename>recipes-kernel</filename> directory holds your append file and your patch file.</para></listitem> <listitem><para><emphasis>Create the layer configuration file</emphasis>: Move to the <filename>meta-mylayer/conf</filename> directory and create @@ -1765,7 +1765,7 @@ BBFILE_PATTERN_mylayer := "^${LAYERDIR}/" BBFILE_PRIORITY_mylayer = "5" </literallayout> - Notice <filename>mylayer</filename> as part of the last three + Notice <filename>mylayer</filename> as part of the last three statements.</para></listitem> <listitem><para><emphasis>Create the kernel recipe append file</emphasis>: Move to the <filename>meta-mylayer/recipes-kernel/linux</filename> directory and create @@ -1775,13 +1775,13 @@ SRC_URI += "file://0001-calibrate-Add-printk-example.patch" - PRINC := "${@int(PRINC) + 1}" + PRINC := "${@int(PRINC) + 1}" </literallayout> The <filename>FILESEXTRAPATHS</filename> and <filename>SRC_URI</filename> statements enable the OpenEmbedded build system to find the patch file. </para></listitem> <listitem><para><emphasis>Put the patch file in your layer</emphasis>: - Move the <filename>0001-calibrate-Add-printk-example.patch</filename> file to + Move the <filename>0001-calibrate-Add-printk-example.patch</filename> file to the <filename>meta-mylayer/recipes-kernel/linux/linux-yocto</filename> directory.</para></listitem> </orderedlist> @@ -1793,25 +1793,25 @@ <para> Do the following to make sure the build parameters are set up for the example. - Once you set up these build parameters, they do not have to change unless you + Once you set up these build parameters, they do not have to change unless you change the target architecture of the machine you are building: <itemizedlist> <listitem><para><emphasis>Build for the Correct Target Architecture:</emphasis> Your selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> - definition within the <filename>local.conf</filename> file in the Build Directory + definition within the <filename>local.conf</filename> file in the Build Directory specifies the target architecture used when building the Linux kernel. - By default, <filename>MACHINE</filename> is set to - <filename>qemux86</filename>, which specifies a 32-bit - <trademark class='registered'>Intel</trademark> Architecture + By default, <filename>MACHINE</filename> is set to + <filename>qemux86</filename>, which specifies a 32-bit + <trademark class='registered'>Intel</trademark> Architecture target machine suitable for the QEMU emulator.</para></listitem> <listitem><para><emphasis>Identify Your <filename>meta-mylayer</filename> - Layer:</emphasis> The <filename>BBLAYERS</filename> variable in the - <filename>bblayers.conf</filename> file found in the + Layer:</emphasis> The <filename>BBLAYERS</filename> variable in the + <filename>bblayers.conf</filename> file found in the <filename>poky/build/conf</filename> directory needs to have the path to your local - <filename>meta-mylayer</filename> layer. - By default, the <filename>BBLAYERS</filename> variable contains paths to - <filename>meta</filename>, <filename>meta-yocto</filename>, and - <filename>meta-yocto-bsp</filename> in the + <filename>meta-mylayer</filename> layer. + By default, the <filename>BBLAYERS</filename> variable contains paths to + <filename>meta</filename>, <filename>meta-yocto</filename>, and + <filename>meta-yocto-bsp</filename> in the <filename>poky</filename> Git repository. Add the path to your <filename>meta-mylayer</filename> location: <literallayout class='monospaced'> @@ -1847,14 +1847,14 @@ </literallayout> </para></listitem> <listitem><para><emphasis>Clean up</emphasis>: - Be sure to clean the shared state out by running the + Be sure to clean the shared state out by running the <filename>cleansstate</filename> BitBake task as follows from your Build Directory: <literallayout class='monospaced'> $ bitbake -c cleansstate linux-yocto </literallayout></para> <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename> directory inside the Build Directory. - Always use the various BitBake clean tasks to clear out previous + Always use the various BitBake clean tasks to clear out previous build artifacts. </note></para></listitem> <listitem><para><emphasis>Build the image</emphasis>: @@ -1873,18 +1873,18 @@ These steps boot the image and allow you to see the changes <orderedlist> <listitem><para><emphasis>Boot the image</emphasis>: - Boot the modified image in the QEMU emulator + Boot the modified image in the QEMU emulator using this command: <literallayout class='monospaced'> $ runqemu qemux86 </literallayout></para></listitem> <listitem><para><emphasis>Verify the changes</emphasis>: - Log into the machine using <filename>root</filename> with no password and then + Log into the machine using <filename>root</filename> with no password and then use the following shell command to scroll through the console's boot output. <literallayout class='monospaced'> # dmesg | less </literallayout> - You should see the results of your <filename>printk</filename> statements + You should see the results of your <filename>printk</filename> statements as part of the output.</para></listitem> </orderedlist> </para> @@ -1895,10 +1895,10 @@ <title>Updating Existing Images</title> <para> - Often, rather than re-flashing a new image, you might wish to install updated - packages into an existing running system. + Often, rather than re-flashing a new image, you might wish to install updated + packages into an existing running system. You can do this by first sharing the <filename>tmp/deploy/ipk/</filename> directory - through a web server and then by changing <filename>/etc/opkg/base-feeds.conf</filename> + through a web server and then by changing <filename>/etc/opkg/base-feeds.conf</filename> to point at the shared server. Following is an example: <literallayout class='monospaced'> @@ -1929,49 +1929,49 @@ <para> If a committed change results in changing the package output, - then the value of the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> - variable needs to be increased - (or "bumped") as part of that commit. + then the value of the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> + variable needs to be increased + (or "bumped") as part of that commit. For new recipes you should add the <filename>PR</filename> - variable and set its initial value equal to "r0", which is the default. - Even though the default value is "r0", the practice of adding it to a new recipe makes - it harder to forget to bump the variable when you make changes + variable and set its initial value equal to "r0", which is the default. + Even though the default value is "r0", the practice of adding it to a new recipe makes + it harder to forget to bump the variable when you make changes to the recipe in future. </para> <para> - If you are sharing a common <filename>.inc</filename> file with multiple recipes, - you can also use the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-INC_PR'>INC_PR</ulink></filename> - variable to ensure that - the recipes sharing the <filename>.inc</filename> file are rebuilt when the - <filename>.inc</filename> file itself is changed. + If you are sharing a common <filename>.inc</filename> file with multiple recipes, + you can also use the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-INC_PR'>INC_PR</ulink></filename> + variable to ensure that + the recipes sharing the <filename>.inc</filename> file are rebuilt when the + <filename>.inc</filename> file itself is changed. The <filename>.inc</filename> file must set <filename>INC_PR</filename> (initially to "r0"), and all recipes referring to it should set <filename>PR</filename> to "$(INC_PR).0" initially, incrementing the last number when the recipe is changed. - If the <filename>.inc</filename> file is changed then its + If the <filename>.inc</filename> file is changed then its <filename>INC_PR</filename> should be incremented. </para> - <para> - When upgrading the version of a package, assuming the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'>PV</ulink></filename> + <para> + When upgrading the version of a package, assuming the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'>PV</ulink></filename> changes, the <filename>PR</filename> variable should be reset to "r0" (or "$(INC_PR).0" if you are using <filename>INC_PR</filename>). </para> <para> Usually, version increases occur only to packages. - However, if for some reason <filename>PV</filename> changes but does not - increase, you can increase the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PE'>PE</ulink></filename> + However, if for some reason <filename>PV</filename> changes but does not + increase, you can increase the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PE'>PE</ulink></filename> variable (Package Epoch). The <filename>PE</filename> variable defaults to "0". </para> <para> - Version numbering strives to follow the + Version numbering strives to follow the <ulink url='http://www.debian.org/doc/debian-policy/ch-controlfields.html'> Debian Version Field Policy Guidelines</ulink>. These guidelines define how versions are compared and what "increasing" a version means. @@ -1982,8 +1982,8 @@ First, to ensure that when a developer updates and rebuilds, they get all the changes to the repository and do not have to remember to rebuild any sections. Second, to ensure that target users are able to upgrade their - devices using package manager commands such as <filename>opkg upgrade</filename> - (or similar commands for dpkg/apt or rpm-based systems). + devices using package manager commands such as <filename>opkg upgrade</filename> + (or similar commands for dpkg/apt or rpm-based systems). </para> <para> @@ -1998,11 +1998,11 @@ package in a different distribution. The OpenEmbedded build system implements a <filename>distro_check</filename> task that automatically connects to major distributions - and checks for these situations. - If the package exists under a different name in a different distribution, you get a - <filename>distro_check</filename> mismatch. - You can resolve this problem by defining a per-distro recipe name alias using the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> + and checks for these situations. + If the package exists under a different name in a different distribution, you get a + <filename>distro_check</filename> mismatch. + You can resolve this problem by defining a per-distro recipe name alias using the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</ulink></filename> variable. </para> @@ -2016,19 +2016,19 @@ ..." </literallayout> </para> - + <para> If you have more than one distribution alias, separate them with a space. - Note that the build system currently automatically checks the - Fedora, OpenSuSE, Debian, Ubuntu, - and Mandriva distributions for source package recipes without having to specify them + Note that the build system currently automatically checks the + Fedora, OpenSuSE, Debian, Ubuntu, + and Mandriva distributions for source package recipes without having to specify them using the <filename>DISTRO_PN_ALIAS</filename> variable. For example, the following command generates a report that lists the Linux distributions that include the sources for each of the recipes. <literallayout class='monospaced'> $ bitbake world -f -c distro_check </literallayout> - The results are stored in the <filename>build/tmp/log/distro_check-${DATETIME}.results</filename> + The results are stored in the <filename>build/tmp/log/distro_check-${DATETIME}.results</filename> file found in the Source Directory. </para> </section> @@ -2037,12 +2037,12 @@ <title>Handling Optional Module Packaging</title> <para> - Many pieces of software split functionality into optional - modules (or plugins) and the plugins that are built - might depend on configuration options. + Many pieces of software split functionality into optional + modules (or plugins) and the plugins that are built + might depend on configuration options. To avoid having to duplicate the logic that determines what - modules are available in your recipe or to avoid having - to package each module by hand, the OpenEmbedded build system + modules are available in your recipe or to avoid having + to package each module by hand, the OpenEmbedded build system provides functionality to handle module packaging dynamically. </para> @@ -2051,7 +2051,7 @@ <itemizedlist> <listitem><para>Ensure the module packaging is actually done</para></listitem> - <listitem><para>Ensure that any dependencies on optional + <listitem><para>Ensure that any dependencies on optional modules from other recipes are satisfied by your recipe </para></listitem> </itemizedlist> @@ -2062,48 +2062,48 @@ <para> To ensure the module packaging actually gets done, you use - the <filename>do_split_packages</filename> function within - the <filename>populate_packages</filename> python function + the <filename>do_split_packages</filename> function within + the <filename>populate_packages</filename> python function in your recipe. The <filename>do_split_packages</filename> function - searches for a pattern of files or directories under a + searches for a pattern of files or directories under a specified path and creates a package for each one it finds - by appending to the <filename>PACKAGES</filename> variable - and setting the appropriate values for - <filename>FILES_packagename</filename>, - <filename>RDEPENDS_packagename</filename>, + by appending to the <filename>PACKAGES</filename> variable + and setting the appropriate values for + <filename>FILES_packagename</filename>, + <filename>RDEPENDS_packagename</filename>, <filename>DESCRIPTION_packagename</filename>, and so forth. - Here is an example from the <filename>lighttpd</filename> + Here is an example from the <filename>lighttpd</filename> recipe: <literallayout class='monospaced'> python populate_packages_prepend () { lighttpd_libdir = d.expand('${libdir}') do_split_packages(d, lighttpd_libdir, '^mod_(.*)\.so$', - 'lighttpd-module-%s', 'Lighttpd module for %s', + 'lighttpd-module-%s', 'Lighttpd module for %s', extra_depends='') } </literallayout> - The previous example specifies a number of things in the + The previous example specifies a number of things in the call to <filename>do_split_packages</filename>. <itemizedlist> - <listitem><para>A directory within the files installed + <listitem><para>A directory within the files installed by your recipe through <filename>do_install</filename> in which to search.</para></listitem> - <listitem><para>A regular expression to match module + <listitem><para>A regular expression to match module files in that directory. - In the example, note the parentheses () that mark - the part of the expression from which the module + In the example, note the parentheses () that mark + the part of the expression from which the module name should be derived.</para></listitem> <listitem><para>A pattern to use for the package names. </para></listitem> <listitem><para>A description for each package. </para></listitem> - <listitem><para>An empty string for - <filename>extra_depends</filename>, which disables - the default dependency on the main - <filename>lighttpd</filename> package. + <listitem><para>An empty string for + <filename>extra_depends</filename>, which disables + the default dependency on the main + <filename>lighttpd</filename> package. Thus, if a file in <filename>${libdir}</filename> - called <filename>mod_alias.so</filename> is found, + called <filename>mod_alias.so</filename> is found, a package called <filename>lighttpd-module-alias</filename> is created for it and the <filename>DESCRIPTION</filename> is set to "Lighttpd module for alias".</para></listitem> @@ -2111,109 +2111,109 @@ </para> <para> - Often, packaging modules is as simple as the previous + Often, packaging modules is as simple as the previous example. - However, more advanced options exist that you can employ - to <filename>do_split_packages</filename> to modify its + However, more advanced options exist that you can employ + to <filename>do_split_packages</filename> to modify its behavior. - And, if you need to, you can add more logic by specifying - a hook function that is called for each package. - It is also perfectly acceptable to call - <filename>do_split_packages</filename> multiple times if + And, if you need to, you can add more logic by specifying + a hook function that is called for each package. + It is also perfectly acceptable to call + <filename>do_split_packages</filename> multiple times if you have more than one set of modules to package. </para> <para> - For more examples that show how to use - <filename>do_split_packages</filename>, see the - <filename>connman.inc</filename> file in the + For more examples that show how to use + <filename>do_split_packages</filename>, see the + <filename>connman.inc</filename> file in the <filename>meta/recipes-connectivity/connman/</filename> directory of the <filename>poky</filename> source repository. - You can also find examples in + You can also find examples in <filename>meta/classes/kernel.bbclass</filename>. </para> <para> - Following is a reference that shows - <filename>do_split_packages</filename> mandatory and + Following is a reference that shows + <filename>do_split_packages</filename> mandatory and optional arguments: <literallayout class='monospaced'> Mandatory arguments - root - The path in which to search - file_regex - Regular expression to match searched files. - Use parentheses () to mark the part of this - expression that should be used to derive the - module name (to be substituted where %s is - used in other function arguments as noted below) - output_pattern - Pattern to use for the package names. Must - include %s. - description - Description to set for each package. Must - include %s. + root + The path in which to search + file_regex + Regular expression to match searched files. + Use parentheses () to mark the part of this + expression that should be used to derive the + module name (to be substituted where %s is + used in other function arguments as noted below) + output_pattern + Pattern to use for the package names. Must + include %s. + description + Description to set for each package. Must + include %s. Optional arguments - postinst - Postinstall script to use for all packages - (as a string) - recursive - True to perform a recursive search - default - False - hook - A hook function to be called for every match. - The function will be called with the following + postinst + Postinstall script to use for all packages + (as a string) + recursive + True to perform a recursive search - default + False + hook + A hook function to be called for every match. + The function will be called with the following arguments (in the order listed): f - Full path to the file/directory match + Full path to the file/directory match pkg - The package name + The package name file_regex - As above + As above output_pattern - As above + As above modulename - The module name derived using file_regex - - extra_depends - Extra runtime dependencies (RDEPENDS) to be - set for all packages. The default value of None - causes a dependency on the main package - (${PN}) - if you do not want this, pass empty - string '' for this parameter. - aux_files_pattern - Extra item(s) to be added to FILES for each - package. Can be a single string item or a list - of strings for multiple items. Must include %s. - postrm - postrm script to use for all packages (as a - string) - allow_dirs - True to allow directories to be matched - - default False - prepend - If True, prepend created packages to PACKAGES - instead of the default False which appends them - match_path - match file_regex on the whole relative path to - the root rather than just the file name - aux_files_pattern_verbatim - Extra item(s) to be added to FILES for each - package, using the actual derived module name - rather than converting it to something legal - for a package name. Can be a single string item - or a list of strings for multiple items. Must - include %s. - allow_links - True to allow symlinks to be matched - default - False + The module name derived using file_regex + + extra_depends + Extra runtime dependencies (RDEPENDS) to be + set for all packages. The default value of None + causes a dependency on the main package + (${PN}) - if you do not want this, pass empty + string '' for this parameter. + aux_files_pattern + Extra item(s) to be added to FILES for each + package. Can be a single string item or a list + of strings for multiple items. Must include %s. + postrm + postrm script to use for all packages (as a + string) + allow_dirs + True to allow directories to be matched - + default False + prepend + If True, prepend created packages to PACKAGES + instead of the default False which appends them + match_path + match file_regex on the whole relative path to + the root rather than just the file name + aux_files_pattern_verbatim + Extra item(s) to be added to FILES for each + package, using the actual derived module name + rather than converting it to something legal + for a package name. Can be a single string item + or a list of strings for multiple items. Must + include %s. + allow_links + True to allow symlinks to be matched - default + False </literallayout> </para> - </section> + </section> <section id='satisfying-dependencies'> <title>Satisfying Dependencies</title> @@ -2221,27 +2221,27 @@ <para> The second part for handling optional module packaging is to ensure that any dependencies on optional modules - from other recipes are satisfied by your recipe. - You can be sure these dependencies are satisfied by - using the - <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></ulink> variable. - Here is an example that continues with the + from other recipes are satisfied by your recipe. + You can be sure these dependencies are satisfied by + using the + <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></ulink> variable. + Here is an example that continues with the <filename>lighttpd</filename> recipe shown earlier: <literallayout class='monospaced'> PACKAGES_DYNAMIC = "lighttpd-module-.*" </literallayout> - The name specified in the regular expression can of + The name specified in the regular expression can of course be anything. - In this example, it is <filename>lighttpd-module-</filename> - and is specified as the prefix to ensure that any + In this example, it is <filename>lighttpd-module-</filename> + and is specified as the prefix to ensure that any <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink> and <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink> on a package name starting with the prefix are satisfied - during build time. + during build time. If you are using <filename>do_split_packages</filename> - as described in the previous section, the value you put in - <filename>PACKAGES_DYNAMIC</filename> should correspond to - the name pattern specified in the call to + as described in the previous section, the value you put in + <filename>PACKAGES_DYNAMIC</filename> should correspond to + the name pattern specified in the call to <filename>do_split_packages</filename>. </para> </section> @@ -2252,32 +2252,32 @@ <title>Building Software from an External Source</title> <para> - By default, the OpenEmbedded build system does its work from within the - <link linkend='build-directory'>Build Directory</link>. + By default, the OpenEmbedded build system does its work from within the + <link linkend='build-directory'>Build Directory</link>. The build process involves fetching the source files, unpacking them, and then patching them if necessary before the build takes place. </para> <para> - Situations exist where you might want to build software from source files that are external to + Situations exist where you might want to build software from source files that are external to and thus outside of the <link linkend='source-directory'>Source Directory</link>. - For example, suppose you have a project that includes a new BSP with a heavily customized + For example, suppose you have a project that includes a new BSP with a heavily customized kernel, a very minimal image, and some new user-space recipes. - And, you want to minimize exposing the build system to the + And, you want to minimize exposing the build system to the development team so that they can focus on their project and maintain everyone's workflow as much as possible. - In this case, you want a kernel source directory on the development machine where the + In this case, you want a kernel source directory on the development machine where the development occurs. - You want the recipe's + You want the recipe's <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> - variable to point to the external directory and use it as is, not copy it. + variable to point to the external directory and use it as is, not copy it. </para> <para> To build from software that comes from an external source, all you need to do is - change your recipe so that it inherits the - <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink> - class and then sets the + change your recipe so that it inherits the + <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink> + class and then sets the <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> variable to point to your external source code. Here are the statements to put in your recipe: @@ -2288,17 +2288,17 @@ </para> <para> - It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the - source directory <filename>S</filename> and the Build Directory + It is important to know that the <filename>externalsrc.bbclass</filename> assumes that the + source directory <filename>S</filename> and the Build Directory <ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink> are different even though by default these directories are the same. This assumption is important because it supports building different variants of the recipe - by using the + by using the <ulink url='&YOCTO_DOCS_REF_URL;#var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></ulink> variable. - You could allow the Build Directory to be the same as the source directory but you would + You could allow the Build Directory to be the same as the source directory but you would not be able to build more than one variant of the recipe. - Consequently, if you are building multiple variants of the recipe, you need to establish a + Consequently, if you are building multiple variants of the recipe, you need to establish a Build Directory that is different than the source directory. </para> </section> @@ -2307,19 +2307,19 @@ <title>Excluding Recipes From the Build</title> <para> - You might find that there are groups of recipes you want to filter + You might find that there are groups of recipes you want to filter out of the build process. - For example, recipes you know you will never use or want should not + For example, recipes you know you will never use or want should not be part of the build. Removing these recipes from parsing speeds up parts of the build. </para> <para> - It is possible to filter or mask out <filename>.bb</filename> and - <filename>.bbappend</filename> files. - You can do this by providing an expression with the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename> - variable. + It is possible to filter or mask out <filename>.bb</filename> and + <filename>.bbappend</filename> files. + You can do this by providing an expression with the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename> + variable. Here is an example: <literallayout class='monospaced'> BBMASK = ".*/meta-mymachine/recipes-maybe/" @@ -2334,23 +2334,23 @@ <title>Using an External SCM</title> <para> - If you're working on a recipe that pulls from an external Source Code Manager (SCM), it - is possible to have the OpenEmbedded build system notice new recipe changes added to the - SCM and then build the resulting package that depends on the new recipes by using the latest - versions. + If you're working on a recipe that pulls from an external Source Code Manager (SCM), it + is possible to have the OpenEmbedded build system notice new recipe changes added to the + SCM and then build the resulting package that depends on the new recipes by using the latest + versions. This only works for SCMs from which it is possible to get a sensible revision number for changes. Currently, you can do this with Apache Subversion (SVN), Git, and Bazaar (BZR) repositories. </para> <para> To enable this behavior, simply add the following to the <filename>local.conf</filename> - configuration file found in the + configuration file found in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> SRCREV_pn-<PN> = "${AUTOREV}" </literallayout> - where <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink> - is the name of the recipe for which you want to enable automatic source + where <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink> + is the name of the recipe for which you want to enable automatic source revision updating. </para> </section> @@ -2359,64 +2359,64 @@ <title>Debugging With the GNU Project Debugger (GDB) Remotely</title> <para> - GDB allows you to examine running programs, which in turn helps you to understand and fix problems. - It also allows you to perform post-mortem style analysis of program crashes. - GDB is available as a package within the Yocto Project and by default is + GDB allows you to examine running programs, which in turn helps you to understand and fix problems. + It also allows you to perform post-mortem style analysis of program crashes. + GDB is available as a package within the Yocto Project and by default is installed in SDK images. - See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter - in the Yocto Project Reference Manual for a description of these images. + See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter + in the Yocto Project Reference Manual for a description of these images. You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>. </para> <tip> - For best results, install <filename>-dbg</filename> packages for the applications + For best results, install <filename>-dbg</filename> packages for the applications you are going to debug. Doing so makes available extra debug symbols that give you more meaningful output. </tip> <para> Sometimes, due to memory or disk space constraints, it is not possible - to use GDB directly on the remote target to debug applications. - These constraints arise because GDB needs to load the debugging information and the - binaries of the process being debugged. - Additionally, GDB needs to perform many computations to locate information such as function - names, variable names and values, stack traces and so forth - even before starting the - debugging process. + to use GDB directly on the remote target to debug applications. + These constraints arise because GDB needs to load the debugging information and the + binaries of the process being debugged. + Additionally, GDB needs to perform many computations to locate information such as function + names, variable names and values, stack traces and so forth - even before starting the + debugging process. These extra computations place more load on the target system and can alter the characteristics of the program being debugged. </para> <para> To help get past the previously mentioned constraints, you can use Gdbserver. - Gdbserver runs on the remote target and does not load any debugging information + Gdbserver runs on the remote target and does not load any debugging information from the debugged process. - Instead, a GDB instance processes the debugging information that is run on a - remote computer - the host GDB. - The host GDB then sends control commands to Gdbserver to make it stop or start the debugged - program, as well as read or write memory regions of that debugged program. - All the debugging information loaded and processed as well + Instead, a GDB instance processes the debugging information that is run on a + remote computer - the host GDB. + The host GDB then sends control commands to Gdbserver to make it stop or start the debugged + program, as well as read or write memory regions of that debugged program. + All the debugging information loaded and processed as well as all the heavy debugging is done by the host GDB. - Offloading these processes gives the Gdbserver running on the target a chance to remain + Offloading these processes gives the Gdbserver running on the target a chance to remain small and fast. </para> <para> - Because the host GDB is responsible for loading the debugging information and - for doing the necessary processing to make actual debugging happen, the + Because the host GDB is responsible for loading the debugging information and + for doing the necessary processing to make actual debugging happen, the user has to make sure the host can access the unstripped binaries complete - with their debugging information and also be sure the target is compiled with no optimizations. - The host GDB must also have local access to all the libraries used by the - debugged program. + with their debugging information and also be sure the target is compiled with no optimizations. + The host GDB must also have local access to all the libraries used by the + debugged program. Because Gdbserver does not need any local debugging information, the binaries on - the remote target can remain stripped. - However, the binaries must also be compiled without optimization + the remote target can remain stripped. + However, the binaries must also be compiled without optimization so they match the host's binaries. </para> <para> - To remain consistent with GDB documentation and terminology, the binary being debugged + To remain consistent with GDB documentation and terminology, the binary being debugged on the remote target machine is referred to as the "inferior" binary. - For documentation on GDB see the + For documentation on GDB see the <ulink url="http://sourceware.org/gdb/documentation/">GDB site</ulink>. </para> @@ -2424,13 +2424,13 @@ <title>Launching Gdbserver on the Target</title> <para> - First, make sure Gdbserver is installed on the target. - If it is not, install the package <filename>gdbserver</filename>, which needs the + First, make sure Gdbserver is installed on the target. + If it is not, install the package <filename>gdbserver</filename>, which needs the <filename>libthread-db1</filename> package. </para> <para> - As an example, to launch Gdbserver on the target and make it ready to "debug" a + As an example, to launch Gdbserver on the target and make it ready to "debug" a program located at <filename>/path/to/inferior</filename>, connect to the target and launch: <literallayout class='monospaced'> @@ -2438,8 +2438,8 @@ </literallayout> Gdbserver should now be listening on port 2345 for debugging commands coming from a remote GDB process that is running on the host computer. - Communication between Gdbserver and the host GDB are done using TCP. - To use other communication protocols, please refer to the + Communication between Gdbserver and the host GDB are done using TCP. + To use other communication protocols, please refer to the <ulink url='http://www.gnu.org/software/gdb/'>Gdbserver documentation</ulink>. </para> </section> @@ -2456,25 +2456,25 @@ <title>Building the Cross-GDB Package</title> <para> A suitable GDB cross-binary is required that runs on your host computer but - also knows about the the ABI of the remote target. + also knows about the the ABI of the remote target. You can get this binary from the meta-toolchain. Here is an example: - <literallayout class='monospaced'> + <literallayout class='monospaced'> /usr/local/poky/eabi-glibc/arm/bin/arm-poky-linux-gnueabi-gdb - </literallayout> - where <filename>arm</filename> is the target architecture and + </literallayout> + where <filename>arm</filename> is the target architecture and <filename>linux-gnueabi</filename> the target ABI. </para> <para> - Alternatively, you can use BitBake to build the <filename>gdb-cross</filename> binary. + Alternatively, you can use BitBake to build the <filename>gdb-cross</filename> binary. Here is an example: <literallayout class='monospaced'> $ bitbake gdb-cross </literallayout> - Once the binary is built, you can find it here: + Once the binary is built, you can find it here: <literallayout class='monospaced'> - tmp/sysroots/<host-arch>/usr/bin/<target-abi>-gdb + tmp/sysroots/<host-arch>/usr/bin/<target-abi>-gdb </literallayout> </para> </section> @@ -2491,24 +2491,24 @@ <para> Perhaps the easiest way is to have an SDK image that corresponds to the plain - image installed on the device. - In the case of <filename>core-image-sato</filename>, - <filename>core-image-sato-sdk</filename> would contain suitable symbols. - Because the SDK images already have the debugging symbols installed, it is just a - question of expanding the archive to some location and then informing GDB. + image installed on the device. + In the case of <filename>core-image-sato</filename>, + <filename>core-image-sato-sdk</filename> would contain suitable symbols. + Because the SDK images already have the debugging symbols installed, it is just a + question of expanding the archive to some location and then informing GDB. </para> <para> - Alternatively, the OpenEmbedded build system can build a custom directory of files - for a specific + Alternatively, the OpenEmbedded build system can build a custom directory of files + for a specific debugging purpose by reusing its <filename>tmp/rootfs</filename> directory. - This directory contains the contents of the last built image. + This directory contains the contents of the last built image. This process assumes two things: <itemizedlist> - <listitem><para>The image running on the target was the last image to + <listitem><para>The image running on the target was the last image to be built.</para></listitem> - <listitem><para>The package (<filename>foo</filename> in the following - example) that contains the inferior binary to be debugged has been built + <listitem><para>The package (<filename>foo</filename> in the following + example) that contains the inferior binary to be debugged has been built without optimization and has debugging information available.</para></listitem> </itemizedlist> </para> @@ -2516,7 +2516,7 @@ <para> The following steps show how to build the custom directory of files: <orderedlist> - <listitem><para>Install the package (<filename>foo</filename> in this case) to + <listitem><para>Install the package (<filename>foo</filename> in this case) to <filename>tmp/rootfs</filename>: <literallayout class='monospaced'> $ tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \ @@ -2541,10 +2541,10 @@ <title>Launch the Host GDB</title> <para> - To launch the host GDB, you run the <filename>cross-gdb</filename> binary and provide - the inferior binary as part of the command line. - For example, the following command form continues with the example used in - the previous section. + To launch the host GDB, you run the <filename>cross-gdb</filename> binary and provide + the inferior binary as part of the command line. + For example, the following command form continues with the example used in + the previous section. This command form loads the <filename>foo</filename> binary as well as the debugging information: <literallayout class='monospaced'> @@ -2556,18 +2556,18 @@ $ set solib-absolute-prefix /path/to/tmp/rootfs </literallayout> The pathname <filename>/path/to/tmp/rootfs</filename> must either be - the absolute path to <filename>tmp/rootfs</filename> or the location at which + the absolute path to <filename>tmp/rootfs</filename> or the location at which binaries with debugging information reside. </para> <para> - At this point you can have GDB connect to the Gdbserver that is running + At this point you can have GDB connect to the Gdbserver that is running on the remote target by using the following command form: <literallayout class='monospaced'> $ target remote remote-target-ip-address:2345 </literallayout> The <filename>remote-target-ip-address</filename> is the IP address of the - remote target where the Gdbserver is running. + remote target where the Gdbserver is running. Port 2345 is the port on which the GDBSERVER is running. </para> </section> @@ -2578,7 +2578,7 @@ <para> You can now proceed with debugging as normal - as if you were debugging on the local machine. - For example, to instruct GDB to break in the "main" function and then + For example, to instruct GDB to break in the "main" function and then continue with execution of the inferior binary use the following commands from within GDB: <literallayout class='monospaced'> @@ -2588,7 +2588,7 @@ </para> <para> - For more information about using GDB, see the project's online documentation at + For more information about using GDB, see the project's online documentation at <ulink url="http://sourceware.org/gdb/download/onlinedocs/"/>. </para> </section> @@ -2599,41 +2599,41 @@ <title>Profiling with OProfile</title> <para> - <ulink url="http://oprofile.sourceforge.net/">OProfile</ulink> is a - statistical profiler well suited for finding performance - bottlenecks in both userspace software and in the kernel. - This profiler provides answers to questions like "Which functions does my application spend - the most time in when doing X?" - Because the OpenEmbedded build system is well integrated with OProfile, it makes profiling + <ulink url="http://oprofile.sourceforge.net/">OProfile</ulink> is a + statistical profiler well suited for finding performance + bottlenecks in both userspace software and in the kernel. + This profiler provides answers to questions like "Which functions does my application spend + the most time in when doing X?" + Because the OpenEmbedded build system is well integrated with OProfile, it makes profiling applications on target hardware straightforward. </para> <para> - To use OProfile, you need an image that has OProfile installed. + To use OProfile, you need an image that has OProfile installed. The easiest way to do this is with <filename>tools-profile</filename> in the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> variable. + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> variable. You also need debugging symbols to be available on the system where the analysis - takes place. + takes place. You can gain access to the symbols by using <filename>dbg-pkgs</filename> in the <filename>IMAGE_FEATURES</filename> variable or by - installing the appropriate <filename>-dbg</filename> packages. + installing the appropriate <filename>-dbg</filename> packages. </para> <para> - For successful call graph analysis, the binaries must preserve the frame - pointer register and should also be compiled with the - <filename>-fno-omit-framepointer</filename> flag. - You can achieve this by setting the + For successful call graph analysis, the binaries must preserve the frame + pointer register and should also be compiled with the + <filename>-fno-omit-framepointer</filename> flag. + You can achieve this by setting the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</ulink></filename> variable with the following options: <literallayout class='monospaced'> -fexpensive-optimizations -fno-omit-framepointer - -frename-registers + -frename-registers -O2 - </literallayout> + </literallayout> You can also achieve it by setting the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DEBUG_BUILD'>DEBUG_BUILD</ulink></filename> + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DEBUG_BUILD'>DEBUG_BUILD</ulink></filename> variable to "1" in the <filename>local.conf</filename> configuration file. If you use the <filename>DEBUG_BUILD</filename> variable, you will also add extra debug information that can make the debug packages large. @@ -2643,7 +2643,7 @@ <title>Profiling on the Target</title> <para> - Using OProfile you can perform all the profiling work on the target device. + Using OProfile you can perform all the profiling work on the target device. A simple OProfile session might look like the following: </para> @@ -2664,19 +2664,19 @@ <para> In this example, the <filename>reset</filename> command clears any previously profiled data. The next command starts OProfile. - The options used when starting the profiler separate dynamic library data + The options used when starting the profiler separate dynamic library data within applications, disable kernel profiling, and enable callgraphing up to - five levels deep. + five levels deep. <note> - To profile the kernel, you would specify the + To profile the kernel, you would specify the <filename>--vmlinux=/path/to/vmlinux</filename> option. - The <filename>vmlinux</filename> file is usually in the source directory in the + The <filename>vmlinux</filename> file is usually in the source directory in the <filename>/boot/</filename> directory and must match the running kernel. </note> </para> - <para> - After you perform your profiling tasks, the next command stops the profiler. + <para> + After you perform your profiling tasks, the next command stops the profiler. After that, you can view results with the <filename>opreport</filename> command with options to see the separate library symbols and callgraph information. </para> @@ -2684,19 +2684,19 @@ <para> Callgraphing logs information about time spent in functions and about a function's calling function (parent) and called functions (children). - The higher the callgraphing depth, the more accurate the results. + The higher the callgraphing depth, the more accurate the results. However, higher depths also increase the logging overhead. - Consequently, you should take care when setting the callgraphing depth. + Consequently, you should take care when setting the callgraphing depth. <note> On ARM, binaries need to have the frame pointer enabled for callgraphing to work. - To accomplish this use the <filename>-fno-omit-framepointer</filename> option + To accomplish this use the <filename>-fno-omit-framepointer</filename> option with <filename>gcc</filename>. </note> </para> <para> - For more information on using OProfile, see the OProfile - online documentation at + For more information on using OProfile, see the OProfile + online documentation at <ulink url="http://oprofile.sourceforge.net/docs/"/>. </para> </section> @@ -2705,15 +2705,15 @@ <title>Using OProfileUI</title> <para> - A graphical user interface for OProfile is also available. + A graphical user interface for OProfile is also available. You can download and build this interface from the Yocto Project at - <ulink url="&YOCTO_GIT_URL;/cgit.cgi/oprofileui/"></ulink>. + <ulink url="&YOCTO_GIT_URL;/cgit.cgi/oprofileui/"></ulink>. If the "tools-profile" image feature is selected, all necessary binaries are installed onto the target device for OProfileUI interaction. </para> <para> - Even though the source directory usually includes all needed patches on the target device, you + Even though the source directory usually includes all needed patches on the target device, you might find you need other OProfile patches for recent OProfileUI features. If so, see the <ulink url='&YOCTO_GIT_URL;/cgit.cgi/oprofileui/tree/README'> OProfileUI README</ulink> for the most recent information. @@ -2723,18 +2723,18 @@ <title>Online Mode</title> <para> - Using OProfile in online mode assumes a working network connection with the target - hardware. - With this connection, you just need to run "oprofile-server" on the device. - By default, OProfile listens on port 4224. + Using OProfile in online mode assumes a working network connection with the target + hardware. + With this connection, you just need to run "oprofile-server" on the device. + By default, OProfile listens on port 4224. <note> - You can change the port using the <filename>--port</filename> command-line + You can change the port using the <filename>--port</filename> command-line option. </note> </para> <para> - The client program is called <filename>oprofile-viewer</filename> and its UI is relatively + The client program is called <filename>oprofile-viewer</filename> and its UI is relatively straightforward. You access key functionality through the buttons on the toolbar, which are duplicated in the menus. @@ -2746,15 +2746,15 @@ </para></listitem> <listitem><para><emphasis>Start:</emphasis> Starts profiling on the device. </para></listitem> - <listitem><para><emphasis>Stop:</emphasis> Stops profiling on the device and - downloads the data to the local host. + <listitem><para><emphasis>Stop:</emphasis> Stops profiling on the device and + downloads the data to the local host. Stopping the profiler generates the profile and displays it in the viewer. </para></listitem> - <listitem><para><emphasis>Download:</emphasis> Downloads the data from the + <listitem><para><emphasis>Download:</emphasis> Downloads the data from the target and generates the profile, which appears in the viewer.</para></listitem> - <listitem><para><emphasis>Reset:</emphasis> Resets the sample data on the device. + <listitem><para><emphasis>Reset:</emphasis> Resets the sample data on the device. Resetting the data removes sample information collected from previous - sampling runs. + sampling runs. Be sure you reset the data if you do not want to include old sample information. </para></listitem> <listitem><para><emphasis>Save:</emphasis> Saves the data downloaded from the @@ -2766,45 +2766,45 @@ <para> The client downloads the complete 'profile archive' from - the target to the host for processing. - This archive is a directory that contains the sample data, the object files, - and the debug information for the object files. - The archive is then converted using the <filename>oparchconv</filename> script, which is + the target to the host for processing. + This archive is a directory that contains the sample data, the object files, + and the debug information for the object files. + The archive is then converted using the <filename>oparchconv</filename> script, which is included in this distribution. The script uses <filename>opimport</filename> to convert the archive from the target to something that can be processed on the host. </para> <para> - Downloaded archives reside in the Build Directory in + Downloaded archives reside in the Build Directory in <filename>/tmp</filename> and are cleared up when they are no longer in use. </para> <para> - If you wish to perform kernel profiling, you need to be sure - a <filename>vmlinux</filename> file that matches the running kernel is available. - In the source directory, that file is usually located in - <filename>/boot/vmlinux-KERNELVERSION</filename>, where - <filename>KERNEL-version</filename> is the version of the kernel. - The OpenEmbedded build system generates separate <filename>vmlinux</filename> + If you wish to perform kernel profiling, you need to be sure + a <filename>vmlinux</filename> file that matches the running kernel is available. + In the source directory, that file is usually located in + <filename>/boot/vmlinux-KERNELVERSION</filename>, where + <filename>KERNEL-version</filename> is the version of the kernel. + The OpenEmbedded build system generates separate <filename>vmlinux</filename> packages for each kernel it builds. - Thus, it should just be a question of making sure a matching package is - installed (e.g. <filename>opkg install kernel-vmlinux</filename>. - The files are automatically installed into development and profiling images - alongside OProfile. - A configuration option exists within the OProfileUI settings page that you can use to - enter the location of the <filename>vmlinux</filename> file. + Thus, it should just be a question of making sure a matching package is + installed (e.g. <filename>opkg install kernel-vmlinux</filename>. + The files are automatically installed into development and profiling images + alongside OProfile. + A configuration option exists within the OProfileUI settings page that you can use to + enter the location of the <filename>vmlinux</filename> file. </para> <para> Waiting for debug symbols to transfer from the device can be slow, and it - is not always necessary to actually have them on the device for OProfile use. - All that is needed is a copy of the filesystem with the debug symbols present - on the viewer system. + is not always necessary to actually have them on the device for OProfile use. + All that is needed is a copy of the filesystem with the debug symbols present + on the viewer system. The "<link linkend='platdev-gdb-remotedebug-launch-gdb'>Launching GDB on the Host Computer</link>" - section covers how to create such a directory with + section covers how to create such a directory with the source directory and how to use the OProfileUI Settings dialog to specify the location. - If you specify the directory, it will be used when the file checksums + If you specify the directory, it will be used when the file checksums match those on the system you are profiling. </para> </section> @@ -2829,8 +2829,8 @@ </para> <para> - In the above example, <filename>my_archive</filename> is the name of the - archive directory where you would like the profile archive to be kept. + In the above example, <filename>my_archive</filename> is the name of the + archive directory where you would like the profile archive to be kept. After the directory is created, you can copy it to another host and load it using <filename>oprofile-viewer</filename> open functionality. If necessary, the archive is converted. @@ -2846,44 +2846,44 @@ One of the concerns for a development organization using open source software is how to maintain compliance with various open source licensing during the lifecycle of the product. - While this section does not provide legal advice or - comprehensively cover all scenarios, it does - present methods that you can use to + While this section does not provide legal advice or + comprehensively cover all scenarios, it does + present methods that you can use to assist you in meeting the compliance requirements during a software release. </para> <para> - With hundreds of different open source licenses that the Yocto - Project tracks, it is difficult to know the requirements of each + With hundreds of different open source licenses that the Yocto + Project tracks, it is difficult to know the requirements of each and every license. However, we can begin to cover the requirements of the major FLOSS licenses, by assuming that there are three main areas of concern: <itemizedlist> <listitem><para>Source code must be provided.</para></listitem> - <listitem><para>License text for the software must be + <listitem><para>License text for the software must be provided.</para></listitem> - <listitem><para>Compilation scripts and modifications to the + <listitem><para>Compilation scripts and modifications to the source code must be provided. </para></listitem> </itemizedlist> There are other requirements beyond the scope of these - three and the methods described in this section + three and the methods described in this section (e.g. the mechanism through which source code is distributed). - As different organizations have different methods of complying with - open source licensing, this section is not meant to imply that - there is only one single way to meet your compliance obligations, + As different organizations have different methods of complying with + open source licensing, this section is not meant to imply that + there is only one single way to meet your compliance obligations, but rather to describe one method of achieving compliance. </para> <para> The remainder of this section describes methods supported to meet the previously mentioned three requirements. - Once you take steps to meet these requirements, + Once you take steps to meet these requirements, and prior to releasing images, sources, and the build system, you should audit all artifacts to ensure completeness. - The Yocto Project generates a license manifest during - image creation that is located + The Yocto Project generates a license manifest during + image creation that is located in <filename>${DEPLOY_DIR}/licenses/<image_name-datestamp></filename> to assist with any audits. </para> @@ -2892,42 +2892,42 @@ <title>Providing the Source Code</title> <para> - Compliance activities should begin before you generate the - final image. + Compliance activities should begin before you generate the + final image. The first thing you should look at is the requirement that tops the list for most compliance groups - providing the source. The Yocto Project has a few ways of meeting this - requirement. + requirement. </para> <para> One of the easiest ways to meet this requirement is - to provide the entire + to provide the entire <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> - used by the build. + used by the build. This method, however, has a few issues. The most obvious is the size of the directory since it includes - all sources used in the build and not just the source used in - the released image. - It will include toolchain source, and other artifacts which - you would not generally release. - But, the more serious issue for most companies is accidental - release of proprietary software. + all sources used in the build and not just the source used in + the released image. + It will include toolchain source, and other artifacts which + you would not generally release. + But, the more serious issue for most companies is accidental + release of proprietary software. The Yocto Project provides an archiver class to help avoid some of these concerns. </para> <para> - Before you employ <filename>DL_DIR</filename> or the + Before you employ <filename>DL_DIR</filename> or the archiver class, you need to decide how you choose to - provide source. - The source archiver class can generate tarballs and SRPMs - and can create them with various levels of compliance in mind. - One way of doing this (but certainly not the only way) is to + provide source. + The source archiver class can generate tarballs and SRPMs + and can create them with various levels of compliance in mind. + One way of doing this (but certainly not the only way) is to release just the original source as a tarball. - You can do this by adding the following to the - <filename>local.conf</filename> file found in the + You can do this by adding the following to the + <filename>local.conf</filename> file found in the <link linkend='build-directory'>Build Directory</link>: <literallayout class='monospaced'> ARCHIVER_MODE ?= "original" @@ -2937,32 +2937,32 @@ SOURCE_ARCHIVE_PACKAGE_TYPE = "tar" </literallayout> During the creation of your image, all GPL - or other copyleft licensed source - is placed within subdirectories of - <filename>DEPLOY_DIR/sources</filename> based on the + or other copyleft licensed source + is placed within subdirectories of + <filename>DEPLOY_DIR/sources</filename> based on the <ulink url='&YOCTO_DOCS_REF_URL;#var-LICENSE'><filename>LICENSE</filename></ulink> - for each recipe. - Releasing the entire directory enables you to comply with + for each recipe. + Releasing the entire directory enables you to comply with requirements concerning providing the unmodified source. It is important to note that the size of the directory can - get large. + get large. </para> <para> A way to help mitigate the size issue is to only release tarballs for licenses that require the release of - source. - Let's assume you are only concerned with GPL code as + source. + Let's assume you are only concerned with GPL code as identified with the following: <literallayout class='monospaced'> $ cd poky/build/tmp/deploy/sources $ mkdir ~/gpl_source_release $ for x in `ls|grep GPL`; do cp -R $x/* ~/gpl_source_release; done </literallayout> - At this point, you could create a tarball from the + At this point, you could create a tarball from the <filename>gpl_source_release</filename> directory and provide that to the end user. - This method would be a step toward achieving compliance + This method would be a step toward achieving compliance with section 3a of GPLv2 and with section 6 of GPLv3. </para> </section> @@ -2971,12 +2971,12 @@ <title>Providing License Text</title> <para> - One requirement that is often overlooked is inclusion + One requirement that is often overlooked is inclusion of license text. - This requirement also needs to be dealt with prior to + This requirement also needs to be dealt with prior to generating the final image. Some licenses require the license text to accompany - the binary. + the binary. You can achieve this by adding the following to your <filename>local.conf</filename> file: <literallayout class='monospaced'> @@ -2986,10 +2986,10 @@ Adding these statements to the configuration file ensures that the licenses collected during package generation are included on your image. - As the source archiver has already archived the original - unmodified source which would contain the license files, - you would have already met the requirements for inclusion - of the license information with source as defined by the GPL + As the source archiver has already archived the original + unmodified source which would contain the license files, + you would have already met the requirements for inclusion + of the license information with source as defined by the GPL and other open source licenses. </para> </section> @@ -2998,7 +2998,7 @@ <title>Providing Compilation Scripts and Source Code Modifications</title> <para> - At this point, we have addressed all we need to address + At this point, we have addressed all we need to address prior to generating the image. The next two requirements are addressed during the final packaging of the release. @@ -3007,20 +3007,20 @@ <para> By releasing the version of the OpenEmbedded build system and the layers used during the build, you will be providing both - compilation scripts and the source code modifications in one + compilation scripts and the source code modifications in one step. </para> <para> - If the deployment team has a + If the deployment team has a <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP layer</ulink> - and a distro layer, and those those layers are used to patch, - compile, package, or modify (in any way) any open source + and a distro layer, and those those layers are used to patch, + compile, package, or modify (in any way) any open source software included in your released images, you - may be required to to release those layers under section 3 of - GPLv2 or section 1 of GPLv3. + may be required to to release those layers under section 3 of + GPLv2 or section 1 of GPLv3. One way of doing that is with a clean - checkout of the version of the Yocto Project and layers used + checkout of the version of the Yocto Project and layers used during your build. Here is an example: <literallayout class='monospaced'> @@ -3033,11 +3033,11 @@ # clean up the .git repos $ find . -name ".git" -type d -exec rm -rf {} \; </literallayout> - One thing a development organization might want to consider - for end-user convenience is to modify + One thing a development organization might want to consider + for end-user convenience is to modify <filename>meta-yocto/conf/bblayers.conf.sample</filename> to - ensure that when the end user utilizes the released build - system to build an image, the development organization's + ensure that when the end user utilizes the released build + system to build an image, the development organization's layers are included in the <filename>bblayers.conf</filename> file automatically: <literallayout class='monospaced'> @@ -3061,15 +3061,15 @@ " </literallayout> Creating and providing an archive of the metadata layers - (recipes, configuration files, and so forth) - enables you to meet your - requirements to include the scripts to control compilation + (recipes, configuration files, and so forth) + enables you to meet your + requirements to include the scripts to control compilation as well as any modifications to the original source. </para> </section> </section> </chapter> -<!-- -vim: expandtab tw=80 ts=4 +<!-- +vim: expandtab tw=80 ts=4 --> diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 99990c4466..d7b589f187 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -10,19 +10,19 @@ <para> Welcome to the Yocto Project Development Manual! - This manual gives you an idea of how to use the Yocto Project to develop embedded Linux - images and user-space applications to run on targeted devices. + This manual gives you an idea of how to use the Yocto Project to develop embedded Linux + images and user-space applications to run on targeted devices. Reading this manual gives you an overview of image, kernel, and user-space application development - using the Yocto Project. + using the Yocto Project. Because much of the information in this manual is general, it contains many references to other sources where you can find more detail. For example, detailed information on Git, repositories and open source in general - can be found in many places. - Another example is how to get set up to use the Yocto Project, which our Yocto Project + can be found in many places. + Another example is how to get set up to use the Yocto Project, which our Yocto Project Quick Start covers. </para> - <para> + <para> The Yocto Project Development Manual, however, does provide detailed examples on how to change the kernel source code, reconfigure the kernel, and develop an application using the popular <trademark class='trade'>Eclipse</trademark> IDE. @@ -35,15 +35,15 @@ <para> The following list describes what you can get from this guide: <itemizedlist> - <listitem><para>Information that lets you get set + <listitem><para>Information that lets you get set up to develop using the Yocto Project.</para></listitem> - <listitem><para>Information to help developers who are new to the open source environment - and to the distributed revision control system Git, which the Yocto Project + <listitem><para>Information to help developers who are new to the open source environment + and to the distributed revision control system Git, which the Yocto Project uses.</para></listitem> <listitem><para>An understanding of common end-to-end development models and tasks.</para></listitem> - <listitem><para>Development case overviews for both system development and user-space + <listitem><para>Development case overviews for both system development and user-space applications.</para></listitem> - <listitem><para>An overview and understanding of the emulation environment used with + <listitem><para>An overview and understanding of the emulation environment used with the Yocto Project - the Quick EMUlator (QEMU).</para></listitem> <listitem><para>An understanding of basic kernel architecture and concepts.</para></listitem> <listitem><para>Many references to other sources of related information.</para></listitem> @@ -57,18 +57,18 @@ <para> This manual will not give you the following: <itemizedlist> - <listitem><para>Step-by-step instructions if those instructions exist in other Yocto - Project documentation. - For example, the Yocto Project Application Developer's Guide contains detailed - instruction on how to run the + <listitem><para>Step-by-step instructions if those instructions exist in other Yocto + Project documentation. + For example, the Yocto Project Application Developer's Guide contains detailed + instruction on how to run the <ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>, which is used to set up a cross-development environment.</para></listitem> - <listitem><para>Reference material. - This type of material resides in an appropriate reference manual. - For example, system variables are documented in the + <listitem><para>Reference material. + This type of material resides in an appropriate reference manual. + For example, system variables are documented in the <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.</para></listitem> - <listitem><para>Detailed public information that is not specific to the Yocto Project. - For example, exhaustive information on how to use Git is covered better through the + <listitem><para>Detailed public information that is not specific to the Yocto Project. + For example, exhaustive information on how to use Git is covered better through the Internet than in this manual.</para></listitem> </itemizedlist> </para> @@ -76,56 +76,56 @@ <section id='other-information'> <title>Other Information</title> - + <para> Because this manual presents overview information for many different topics, you will need to supplement it with other information. The following list presents other sources of information you might find helpful: <itemizedlist> <listitem><para><emphasis>The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: - </emphasis> The home page for the Yocto Project provides lots of information on the project + </emphasis> The home page for the Yocto Project provides lots of information on the project as well as links to software and documentation.</para></listitem> <listitem><para><emphasis> - <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started + <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started with the Yocto Project quickly and start building an image.</para></listitem> - <listitem><para><emphasis> - <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference - guide to the OpenEmbedded build system known as "Poky." - The manual also contains a reference chapter on Board Support Package (BSP) + <listitem><para><emphasis> + <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference + guide to the OpenEmbedded build system known as "Poky." + The manual also contains a reference chapter on Board Support Package (BSP) layout.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis> - This guide provides information that lets you get going with the Application - Development Toolkit (ADT) and stand-alone cross-development toolchains to + This guide provides information that lets you get going with the Application + Development Toolkit (ADT) and stand-alone cross-development toolchains to develop projects using the Yocto Project.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> - This guide defines the structure for BSP components. + This guide defines the structure for BSP components. Having a commonly understood structure encourages standardization.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> - This manual describes the architecture of the Yocto Project kernel and provides + This manual describes the architecture of the Yocto Project kernel and provides some work flow examples.</para></listitem> <listitem><para><emphasis> <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> Eclipse IDE Yocto Plug-in</ulink>:</emphasis> A step-by-step instructional video that - demonstrates how an application developer uses Yocto Plug-in features within + demonstrates how an application developer uses Yocto Plug-in features within the Eclipse IDE.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis> A list of commonly asked questions and their answers.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-&DISTRO;-release-notes-poky-&POKYVERSION;'> - Release Notes</ulink>:</emphasis> Features, updates and known issues for the current + Release Notes</ulink>:</emphasis> Features, updates and known issues for the current release of the Yocto Project.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_HOME_URL;/projects/hob'> - Hob</ulink>:</emphasis> A graphical user interface for BitBake. + Hob</ulink>:</emphasis> A graphical user interface for BitBake. Hob's primary goal is to enable a user to perform common tasks more easily.</para></listitem> <listitem><para><emphasis> <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'> - Build Appliance</ulink>:</emphasis> A bootable custom embedded Linux image you can - either build using a non-Linux development system (VMware applications) or download + Build Appliance</ulink>:</emphasis> A bootable custom embedded Linux image you can + either build using a non-Linux development system (VMware applications) or download from the Yocto Project website. See the <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page for more information.</para></listitem> @@ -135,20 +135,20 @@ If you find problems with the Yocto Project, you should report them using this application.</para></listitem> <listitem><para><emphasis> - Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing + Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing lists, click on the following URLs and follow the instructions: <itemizedlist> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a + <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a Yocto Project Discussions mailing list.</para></listitem> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a + <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a Yocto Project Discussions mailing list about the Poky build system.</para></listitem> <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> for a mailing list to receive official Yocto Project announcements for developments and as well as Yocto Project milestones.</para></listitem> </itemizedlist></para></listitem> <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis> - Two IRC channels on freenode are available - for Yocto Project and Poky discussions: <filename>#yocto</filename> and + Two IRC channels on freenode are available + for Yocto Project and Poky discussions: <filename>#yocto</filename> and <filename>#poky</filename>, respectively.</para></listitem> <listitem><para><emphasis> <ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis> @@ -157,30 +157,30 @@ OpenedHand was acquired by Intel Corporation in 2008.</para></listitem> <listitem><para><emphasis> <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> - A multinational semiconductor chip manufacturer company whose Software and + A multinational semiconductor chip manufacturer company whose Software and Services Group created and supports the Yocto Project. Intel acquired OpenedHand in 2008.</para></listitem> <listitem><para><emphasis> <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> - The build system used by the Yocto Project. - This project is the upstream, generic, embedded distribution from which the Yocto + The build system used by the Yocto Project. + This project is the upstream, generic, embedded distribution from which the Yocto Project derives its build system (Poky) from and to which it contributes.</para></listitem> <listitem><para><emphasis> <ulink url='http://developer.berlios.de/projects/bitbake/'> - BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system + BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system to process project metadata.</para></listitem> <listitem><para><emphasis> BitBake User Manual:</emphasis> A comprehensive guide to the BitBake tool. - If you want information on BitBake, see the user manual inculded in the - <filename>bitbake/doc/manual</filename> directory of the + If you want information on BitBake, see the user manual inculded in the + <filename>bitbake/doc/manual</filename> directory of the <link linkend='source-directory'>Source Directory</link>.</para></listitem> <listitem><para><emphasis> <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>: </emphasis> An open-source machine emulator and virtualizer.</para></listitem> </itemizedlist> </para> - </section> + </section> </chapter> <!-- vim: expandtab tw=80 ts=4 diff --git a/documentation/dev-manual/dev-manual-kernel-appendix-orig.xml b/documentation/dev-manual/dev-manual-kernel-appendix-orig.xml index 6ea77d030c..7765feb9c1 100644 --- a/documentation/dev-manual/dev-manual-kernel-appendix-orig.xml +++ b/documentation/dev-manual/dev-manual-kernel-appendix-orig.xml @@ -7,16 +7,16 @@ <title>Kernel Modification Example</title> <para> - Kernel modification involves changing or adding configurations to an existing kernel, - changing or adding recipes to the kernel that are needed to support specific hardware features, - or even altering the source code itself. - This appendix presents simple examples that modify the kernel source code, + Kernel modification involves changing or adding configurations to an existing kernel, + changing or adding recipes to the kernel that are needed to support specific hardware features, + or even altering the source code itself. + This appendix presents simple examples that modify the kernel source code, change the kernel configuration, and add a kernel source recipe. <note> You can use the <filename>yocto-kernel</filename> script found in the <link linkend='source-directory'>Source Directory</link> under <filename>scripts</filename> to manage kernel patches and configuration. - See the "<ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'>Managing kernel Patches and Config Items with yocto-kernel</ulink>" + See the "<ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'>Managing kernel Patches and Config Items with yocto-kernel</ulink>" section in the Yocto Project Board Support Packages (BSP) Developer's Guide for more information.</note> </para> @@ -25,87 +25,87 @@ <title>Modifying the Kernel Source Code</title> <para> - This example adds some simple QEMU emulator console output at boot time by + This example adds some simple QEMU emulator console output at boot time by adding <filename>printk</filename> statements to the kernel's <filename>calibrate.c</filename> source code file. Booting the modified image causes the added messages to appear on the emulator's console. - </para> + </para> <section id='understanding-the-files-you-need'> <title>Understanding the Files You Need</title> - + <para> - Before you modify the kernel, you need to know what Git repositories and file + Before you modify the kernel, you need to know what Git repositories and file structures you need. - Briefly, you need the following: + Briefly, you need the following: <itemizedlist> - <listitem><para>A local - <link linkend='source-directory'>Source Directory</link> for the + <listitem><para>A local + <link linkend='source-directory'>Source Directory</link> for the poky Git repository</para></listitem> <listitem><para>Local copies of the <link linkend='poky-extras-repo'><filename>poky-extras</filename></link> - Git repository placed within the Source Directory.</para></listitem> - <listitem><para>A bare clone of the - <link linkend='local-kernel-files'>Yocto Project Kernel</link> upstream Git + Git repository placed within the Source Directory.</para></listitem> + <listitem><para>A bare clone of the + <link linkend='local-kernel-files'>Yocto Project Kernel</link> upstream Git repository to which you want to push your modifications. </para></listitem> - <listitem><para>A copy of that bare clone in which you make your source + <listitem><para>A copy of that bare clone in which you make your source modifications</para></listitem> </itemizedlist> </para> - <para> - The following figure summarizes these four areas. - Within each rectangular that represents a data structure, a - host development directory pathname appears at the - lower left-hand corner of the box. + <para> + The following figure summarizes these four areas. + Within each rectangular that represents a data structure, a + host development directory pathname appears at the + lower left-hand corner of the box. These pathnames are the locations used in this example. The figure also provides key statements and commands used during the kernel modification process: </para> <para> - <imagedata fileref="figures/kernel-example-repos-generic.png" width="7in" depth="5in" + <imagedata fileref="figures/kernel-example-repos-generic.png" width="7in" depth="5in" align="center" scale="100" /> </para> <para> Here is a brief description of the four areas: <itemizedlist> - <listitem><para><emphasis>Local Source Directory:</emphasis> - This area contains all the metadata that supports building images + <listitem><para><emphasis>Local Source Directory:</emphasis> + This area contains all the metadata that supports building images using the OpenEmbedded build system. - In this example, the - <link linkend='source-directory'>Source Directory</link> also - contains the - <link linkend='build-directory'>Build Directory</link>, - which contains the configuration directory + In this example, the + <link linkend='source-directory'>Source Directory</link> also + contains the + <link linkend='build-directory'>Build Directory</link>, + which contains the configuration directory that lets you control the build. - Also in this example, the Source Directory contains local copies of the + Also in this example, the Source Directory contains local copies of the <filename>poky-extras</filename> Git repository.</para> <para>See the bulleted item "<link linkend='local-yp-release'>Yocto Project Release</link>" for information on how to get these files on your local system.</para></listitem> - <listitem><para><emphasis>Local copies of the <filename>poky-extras</filename> Git Repository:</emphasis> - This area contains the <filename>meta-kernel-dev</filename> layer, + <listitem><para><emphasis>Local copies of the <filename>poky-extras</filename> Git Repository:</emphasis> + This area contains the <filename>meta-kernel-dev</filename> layer, which is where you make changes that append the kernel build recipes. - You edit <filename>.bbappend</filename> files to locate your + You edit <filename>.bbappend</filename> files to locate your local kernel source files and to identify the kernel being built. This Git repository is a gathering place for extensions to the Yocto Project (or really any) kernel recipes that faciliate the creation and development of kernel features, BSPs or configurations.</para> <para>See the bulleted item - "<link linkend='poky-extras-repo'>The - <filename>poky-extras</filename> Git Repository</link>" - for information on how to get these files.</para></listitem> - <listitem><para><emphasis>Bare Clone of the Yocto Project kernel:</emphasis> - This bare Git repository tracks the upstream Git repository of the Linux + "<link linkend='poky-extras-repo'>The + <filename>poky-extras</filename> Git Repository</link>" + for information on how to get these files.</para></listitem> + <listitem><para><emphasis>Bare Clone of the Yocto Project kernel:</emphasis> + This bare Git repository tracks the upstream Git repository of the Linux Yocto kernel source code you are changing. When you modify the kernel you must work through a bare clone. - All source code changes you make to the kernel must be committed and + All source code changes you make to the kernel must be committed and pushed to the bare clone using Git commands. - As mentioned, the <filename>.bbappend</filename> file in the + As mentioned, the <filename>.bbappend</filename> file in the <filename>poky-extras</filename> repository points to the bare clone so that the build process can locate the locally changed source files.</para> <para>See the bulleted item @@ -113,16 +113,16 @@ for information on how to set up the bare clone. </para></listitem> <listitem><para><emphasis>Copy of the Yocto Project Kernel Bare Clone:</emphasis> - This Git repository contains the actual source files that you modify. + This Git repository contains the actual source files that you modify. Any changes you make to files in this location need to ultimately be pushed to the bare clone using the <filename>git push</filename> command.</para> <para>See the bulleted item "<link linkend='local-kernel-files'>Yocto Project Kernel</link>" for information on how to set up the bare clone. - <note>Typically, Git workflows follow a scheme where changes made to a local area + <note>Typically, Git workflows follow a scheme where changes made to a local area are pulled into a Git repository. - However, because the <filename>git pull</filename> command does not work - with bare clones, this workflow pushes changes to the + However, because the <filename>git pull</filename> command does not work + with bare clones, this workflow pushes changes to the repository even though you could use other more complicated methods to get changes into the bare clone.</note> </para></listitem> @@ -134,11 +134,11 @@ <title>Setting Up the Local Source Directory</title> <para> - You can set up the + You can set up the <link linkend='source-directory'>Source Directory</link> - through tarball extraction or by - cloning the <filename>poky</filename> Git repository. - This example uses <filename>poky</filename> as the root directory of the + through tarball extraction or by + cloning the <filename>poky</filename> Git repository. + This example uses <filename>poky</filename> as the root directory of the local Source Directory. See the bulleted item "<link linkend='local-yp-release'>Yocto Project Release</link>" @@ -146,17 +146,17 @@ </para> <para> - Once you have Source Directory set up, - you have many development branches from which you can work. - From inside the local repository you can see the branch names and the tag names used + Once you have Source Directory set up, + you have many development branches from which you can work. + From inside the local repository you can see the branch names and the tag names used in the upstream Git repository by using either of the following commands: <literallayout class='monospaced'> $ cd poky $ git branch -a $ git tag -l - </literallayout> - This example uses the Yocto Project &DISTRO; Release code named "&DISTRO_NAME;", - which maps to the <filename>&DISTRO_NAME;</filename> branch in the repository. + </literallayout> + This example uses the Yocto Project &DISTRO; Release code named "&DISTRO_NAME;", + which maps to the <filename>&DISTRO_NAME;</filename> branch in the repository. The following commands create and checkout the local <filename>&DISTRO_NAME;</filename> branch: <literallayout class='monospaced'> @@ -171,20 +171,20 @@ <title>Setting Up the Local poky-extras Git Repository</title> <para> - This example creates a local copy of the <filename>poky-extras</filename> Git + This example creates a local copy of the <filename>poky-extras</filename> Git repository inside the <filename>poky</filename> Source Directory. - See the bulleted item "<link linkend='poky-extras-repo'>The - <filename>poky-extras</filename> Git Repository</link>" + See the bulleted item "<link linkend='poky-extras-repo'>The + <filename>poky-extras</filename> Git Repository</link>" for information on how to set up a local copy of the <filename>poky-extras</filename> repository. </para> <para> - Because this example uses the Yocto Project &DISTRO; Release code - named "&DISTRO_NAME;", which maps to the <filename>&DISTRO_NAME;</filename> - branch in the repository, you need to be sure you are using that + Because this example uses the Yocto Project &DISTRO; Release code + named "&DISTRO_NAME;", which maps to the <filename>&DISTRO_NAME;</filename> + branch in the repository, you need to be sure you are using that branch for <filename>poky-extras</filename>. - The following commands create and checkout the local + The following commands create and checkout the local branch you are using for the <filename>&DISTRO_NAME;</filename> branch: <literallayout class='monospaced'> @@ -201,25 +201,25 @@ <para> This example modifies the <filename>linux-yocto-3.4</filename> kernel. - Thus, you need to create a bare clone of that kernel and then make a copy of the + Thus, you need to create a bare clone of that kernel and then make a copy of the bare clone. See the bulleted item - "<link linkend='local-kernel-files'>Yocto Project Kernel</link>" + "<link linkend='local-kernel-files'>Yocto Project Kernel</link>" for information on how to do that. </para> <para> - The bare clone exists for the kernel build tools and simply as the receiving end + The bare clone exists for the kernel build tools and simply as the receiving end of <filename>git push</filename> commands after you make edits and commits inside the copy of the clone. - The copy (<filename>my-linux-yocto-3.4-work</filename> in this example) has to have + The copy (<filename>my-linux-yocto-3.4-work</filename> in this example) has to have a local branch created and checked out for your work. This example uses <filename>common-pc-base</filename> as the local branch. The following commands create and checkout the branch: <literallayout class='monospaced'> $ cd ~/my-linux-yocto-3.4-work $ git checkout -b standard-common-pc-base origin/standard/common-pc/base - Branch standard-common-pc-base set up to track remote branch + Branch standard-common-pc-base set up to track remote branch standard/common-pc/base from origin. Switched to a new branch 'standard-common-pc-base' </literallayout> @@ -230,22 +230,22 @@ <title>Building and Booting the Default QEMU Kernel Image</title> <para> - Before we make changes to the kernel source files, this example first builds the + Before we make changes to the kernel source files, this example first builds the default image and then boots it inside the QEMU emulator. <note> - Because a full build can take hours, you should check two variables in the - <filename>build</filename> directory that is created after you source the + Because a full build can take hours, you should check two variables in the + <filename>build</filename> directory that is created after you source the <filename>&OE_INIT_FILE;</filename> script. You can find these variables <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename> - in the <filename>build/conf</filename> directory in the + in the <filename>build/conf</filename> directory in the <filename>local.conf</filename> configuration file. By default, these variables are commented out. If your host development system supports multi-core and multi-thread capabilities, you can uncomment these statements and set the variables to significantly shorten the full build time. - As a guideline, set both <filename>BB_NUMBER_THREADS</filename> and - <filename>PARALLEL_MAKE</filename> to twice the number + As a guideline, set both <filename>BB_NUMBER_THREADS</filename> and + <filename>PARALLEL_MAKE</filename> to twice the number of cores your machine supports. </note> The following two commands <filename>source</filename> the build environment setup script @@ -255,9 +255,9 @@ $ cd ~/poky $ source &OE_INIT_FILE; You had no conf/local.conf file. This configuration file has therefore been - created for you with some default values. You may wish to edit it to use a - different MACHINE (target hardware) or enable parallel build options to take - advantage of multiple cores for example. See the file for more information as + created for you with some default values. You may wish to edit it to use a + different MACHINE (target hardware) or enable parallel build options to take + advantage of multiple cores for example. See the file for more information as common configuration options are commented. The Yocto Project has extensive documentation about OE including a reference manual @@ -305,7 +305,7 @@ before starting the build.</note> </para> - <para> + <para> After the build completes, you can start the QEMU emulator using the resulting image <filename>qemux86</filename> as follows: <literallayout class='monospaced'> @@ -317,9 +317,9 @@ As the image boots in the emulator, console message and status output appears across the terminal window. Because the output scrolls by quickly, it is difficult to read. - To examine the output, you log into the system using the + To examine the output, you log into the system using the login <filename>root</filename> with no password. - Once you are logged in, issue the following command to scroll through the + Once you are logged in, issue the following command to scroll through the console output: <literallayout class='monospaced'> # dmesg | less @@ -360,7 +360,7 @@ </para> <para> - Here is the altered code showing five new <filename>printk</filename> statements + Here is the altered code showing five new <filename>printk</filename> statements near the top of the function: <literallayout class='monospaced'> void __cpuinit calibrate_delay(void) @@ -392,9 +392,9 @@ </para> <para> - Once the source code has been modified, you need to use Git to push the changes to - the bare clone. - If you do not push the changes, then the OpenEmbedded build system will not pick + Once the source code has been modified, you need to use Git to push the changes to + the bare clone. + If you do not push the changes, then the OpenEmbedded build system will not pick up the changed source files. </para> @@ -411,43 +411,43 @@ <para> At this point, the source has been changed and pushed. - The example now defines some variables used by the OpenEmbedded build system + The example now defines some variables used by the OpenEmbedded build system to locate your kernel source. You essentially need to identify where to find the kernel recipe and the changed source code. - You also need to be sure some basic configurations are in place that identify the + You also need to be sure some basic configurations are in place that identify the type of machine you are building and to help speed up the build should your host support multiple-core and thread capabilities. </para> <para> Do the following to make sure the build parameters are set up for the example. - Once you set up these build parameters, they do not have to change unless you + Once you set up these build parameters, they do not have to change unless you change the target architecture of the machine you are building or you move the bare clone, copy of the clone, or the <filename>poky-extras</filename> repository: <itemizedlist> - <listitem><para><emphasis>Build for the Correct Target Architecture:</emphasis> The - <filename>local.conf</filename> file in the build directory defines the build's + <listitem><para><emphasis>Build for the Correct Target Architecture:</emphasis> The + <filename>local.conf</filename> file in the build directory defines the build's target architecture. - By default, <filename>MACHINE</filename> is set to - <filename>qemux86</filename>, which specifies a 32-bit - <trademark class='registered'>Intel</trademark> Architecture - target machine suitable for the QEMU emulator. + By default, <filename>MACHINE</filename> is set to + <filename>qemux86</filename>, which specifies a 32-bit + <trademark class='registered'>Intel</trademark> Architecture + target machine suitable for the QEMU emulator. In this example, <filename>MACHINE</filename> is correctly configured. </para></listitem> - <listitem><para><emphasis>Optimize Build Time:</emphasis> Also in the - <filename>local.conf</filename> file are two variables that can speed your + <listitem><para><emphasis>Optimize Build Time:</emphasis> Also in the + <filename>local.conf</filename> file are two variables that can speed your build time if your host supports multi-core and multi-thread capabilities: <filename>BB_NUMBER_THREADS</filename> and <filename>PARALLEL_MAKE</filename>. - If the host system has multiple cores then you can optimize build time - by setting both these variables to twice the number of + If the host system has multiple cores then you can optimize build time + by setting both these variables to twice the number of cores.</para></listitem> <listitem><para><emphasis>Identify Your <filename>meta-kernel-dev</filename> - Layer:</emphasis> The <filename>BBLAYERS</filename> variable in the - <filename>bblayers.conf</filename> file found in the + Layer:</emphasis> The <filename>BBLAYERS</filename> variable in the + <filename>bblayers.conf</filename> file found in the <filename>poky/build/conf</filename> directory needs to have the path to your local - <filename>meta-kernel-dev</filename> layer. - By default, the <filename>BBLAYERS</filename> variable contains paths to - <filename>meta</filename> and <filename>meta-yocto</filename> in the + <filename>meta-kernel-dev</filename> layer. + By default, the <filename>BBLAYERS</filename> variable contains paths to + <filename>meta</filename> and <filename>meta-yocto</filename> in the <filename>poky</filename> Git repository. Add the path to your <filename>meta-kernel-dev</filename> location. Be sure to substitute your user information in the statement. @@ -460,14 +460,14 @@ /home/scottrif/poky/poky-extras/meta-kernel-dev \ " </literallayout></para></listitem> - <listitem><para><emphasis>Identify Your Source Files:</emphasis> In the - <filename>linux-yocto_3.4.bbappend</filename> file located in the + <listitem><para><emphasis>Identify Your Source Files:</emphasis> In the + <filename>linux-yocto_3.4.bbappend</filename> file located in the <filename>poky-extras/meta-kernel-dev/recipes-kernel/linux</filename> - directory, you need to identify the location of the + directory, you need to identify the location of the local source code, which in this example is the bare clone named <filename>linux-yocto-3.4.git</filename>. To do this, set the <filename>KSRC_linux_yocto</filename> variable to point to your - local <filename>linux-yocto-3.4.git</filename> Git repository by adding the + local <filename>linux-yocto-3.4.git</filename> Git repository by adding the following statement. Also, be sure the <filename>SRC_URI</filename> variable is pointing to your kernel source files by removing the comment. @@ -480,20 +480,20 @@ </para> <note> - <para>Before attempting to build the modified kernel, there is one more set of changes you + <para>Before attempting to build the modified kernel, there is one more set of changes you need to make in the <filename>meta-kernel-dev</filename> layer. - Because all the kernel <filename>.bbappend</filename> files are parsed during the - build process regardless of whether you are using them or not, you should either - comment out the <filename>COMPATIBLE_MACHINE</filename> statements in all - unused <filename>.bbappend</filename> files, or simply remove (or rename) all the files - except the one your are using for the build + Because all the kernel <filename>.bbappend</filename> files are parsed during the + build process regardless of whether you are using them or not, you should either + comment out the <filename>COMPATIBLE_MACHINE</filename> statements in all + unused <filename>.bbappend</filename> files, or simply remove (or rename) all the files + except the one your are using for the build (i.e. <filename>linux-yocto_3.4.bbappend</filename> in this example).</para> <para>If you do not make one of these two adjustments, your machine will be compatible - with all the kernel recipes in the <filename>meta-kernel-dev</filename> layer. + with all the kernel recipes in the <filename>meta-kernel-dev</filename> layer. When your machine is comapatible with all the kernel recipes, the build attempts to build all kernels in the layer. You could end up with build errors blocking your work.</para> - </note> + </note> </section> <section id='building-and-booting-the-modified-qemu-kernel-image'> @@ -511,7 +511,7 @@ $ source &OE_INIT_FILE; </literallayout> </para></listitem> - <listitem><para>Be sure old images are cleaned out by running the + <listitem><para>Be sure old images are cleaned out by running the <filename>cleanall</filename> BitBake task as follows from your build directory: <literallayout class='monospaced'> $ bitbake -c cleanall linux-yocto @@ -524,7 +524,7 @@ <literallayout class='monospaced'> $ bitbake -k core-image-minimal </literallayout></para></listitem> - <listitem><para>Finally, boot the modified image in the QEMU emulator + <listitem><para>Finally, boot the modified image in the QEMU emulator using this command: <literallayout class='monospaced'> $ runqemu qemux86 @@ -533,7 +533,7 @@ </para> <para> - Log into the machine using <filename>root</filename> with no password and then + Log into the machine using <filename>root</filename> with no password and then use the following shell command to scroll through the console's boot output. <literallayout class='monospaced'> # dmesg | less @@ -541,7 +541,7 @@ </para> <para> - You should see the results of your <filename>printk</filename> statements + You should see the results of your <filename>printk</filename> statements as part of the output. </para> </section> diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 3ec9eae37b..442cab3036 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -7,41 +7,41 @@ <title>Common Development Models</title> <para> - Many development models exist for which you can use the Yocto Project. - This chapter overviews simple methods that use tools provided by the + Many development models exist for which you can use the Yocto Project. + This chapter overviews simple methods that use tools provided by the Yocto Project: <itemizedlist> <listitem><para><emphasis>System Development:</emphasis> - System Development covers Board Support Package (BSP) development and kernel + System Development covers Board Support Package (BSP) development and kernel modification or configuration. - For an example on how to create a BSP, see the + For an example on how to create a BSP, see the "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" section in the Yocto Project Board Support Package (BSP) Developer's Guide. </para></listitem> <listitem><para><emphasis>User Application Development:</emphasis> - User Application Development covers development of applications that you intend + User Application Development covers development of applications that you intend to run on some target hardware. For information on how to set up your host development system for user-space - application development, see the + application development, see the <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>. - For a simple example of user-space application development using the - <trademark class='trade'>Eclipse</trademark> IDE, see the - "<link linkend='application-development-workflow'>Application + For a simple example of user-space application development using the + <trademark class='trade'>Eclipse</trademark> IDE, see the + "<link linkend='application-development-workflow'>Application Development Workflow</link>" section. </para></listitem> <listitem><para><emphasis>Temporary Source Code Modification:</emphasis> Direct modification of temporary source code is a convenient development model to quickly iterate and develop towards a solution. - Once the solution has been implemented, you should of course take steps to + Once the solution has been implemented, you should of course take steps to get the changes upstream and applied in the affected recipes.</para></listitem> <listitem><para><emphasis>Image Development using Hob:</emphasis> - You can use the <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> to build + You can use the <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> to build custom operating system images within the build environment. Hob provides an efficient interface to the OpenEmbedded build system.</para></listitem> <listitem><para><emphasis>Using a Development Shell:</emphasis> - You can use a <filename>devshell</filename> to efficiently debug commands or simply + You can use a <filename>devshell</filename> to efficiently debug commands or simply edit packages. - Working inside a development shell is a quick way to set up the OpenEmbedded build + Working inside a development shell is a quick way to set up the OpenEmbedded build environment to work on parts of a project.</para></listitem> </itemizedlist> </para> @@ -50,17 +50,17 @@ <title>System Development Workflow</title> <para> - System development involves modification or creation of an image that you want to run on - a specific hardware target. - Usually, when you want to create an image that runs on embedded hardware, the image does + System development involves modification or creation of an image that you want to run on + a specific hardware target. + Usually, when you want to create an image that runs on embedded hardware, the image does not require the same number of features that a full-fledged Linux distribution provides. - Thus, you can create a much smaller image that is designed to use only the + Thus, you can create a much smaller image that is designed to use only the features for your particular hardware. </para> <para> - To help you understand how system development works in the Yocto Project, this section - covers two types of image development: BSP creation and kernel modification or + To help you understand how system development works in the Yocto Project, this section + covers two types of image development: BSP creation and kernel modification or configuration. </para> @@ -68,19 +68,19 @@ <title>Developing a Board Support Package (BSP)</title> <para> - A BSP is a package of recipes that, when applied during a build, results in - an image that you can run on a particular board. - Thus, the package when compiled into the new image, supports the operation of the board. + A BSP is a package of recipes that, when applied during a build, results in + an image that you can run on a particular board. + Thus, the package when compiled into the new image, supports the operation of the board. </para> <note> - For a brief list of terms used when describing the development process in the Yocto Project, + For a brief list of terms used when describing the development process in the Yocto Project, see the "<link linkend='yocto-project-terms'>Yocto Project Terms</link>" section. </note> <para> - The remainder of this section presents the basic steps used to create a BSP - using the Yocto Project's + The remainder of this section presents the basic steps used to create a BSP + using the Yocto Project's <ulink url='&YOCTO_DOCS_BSP_URL;#using-the-yocto-projects-bsp-tools'>BSP Tools</ulink>. For an example that shows how to create a new layer using the tools, see the "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" @@ -97,73 +97,73 @@ <para> <orderedlist> - <listitem><para><emphasis>Set up your host development system to support + <listitem><para><emphasis>Set up your host development system to support development using the Yocto Project</emphasis>: See the - "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" - and the + "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" + and the "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both in the Yocto Project Quick Start for requirements.</para></listitem> - <listitem><para><emphasis>Establish a local copy of the project files on your - system</emphasis>: You need this <link linkend='source-directory'>Source - Directory</link> available on your host system. + <listitem><para><emphasis>Establish a local copy of the project files on your + system</emphasis>: You need this <link linkend='source-directory'>Source + Directory</link> available on your host system. Having these files on your system gives you access to the build process and to the tools you need. - For information on how to set up the + For information on how to set up the <link linkend='source-directory'>Source Directory</link>, see the "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem> <listitem><para><emphasis>Establish the <filename>meta-intel</filename> - repository on your system</emphasis>: Having local copies of the + repository on your system</emphasis>: Having local copies of the supported BSP layers on your system gives you access to the build process and to the tools you need for creating a BSP. For information on how to get these files, see the - "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem> - <listitem><para><emphasis>Create your own BSP layer using the - <ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'><filename>yocto-bsp</filename></ulink> script</emphasis>: - Layers are ideal for - isolating and storing work for a given piece of hardware. + "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem> + <listitem><para><emphasis>Create your own BSP layer using the + <ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'><filename>yocto-bsp</filename></ulink> script</emphasis>: + Layers are ideal for + isolating and storing work for a given piece of hardware. A layer is really just a location or area in which you place the recipes for your BSP. In fact, a BSP is, in itself, a special type of layer. - The simplest way to create a new BSP layer that is compliant with the - Yocto Project is to use the <filename>yocto-bsp</filename> script. - For information about that script, see the - "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" - section in the Yocto Project Board Support (BSP) Developer's Guide. + The simplest way to create a new BSP layer that is compliant with the + Yocto Project is to use the <filename>yocto-bsp</filename> script. + For information about that script, see the + "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" + section in the Yocto Project Board Support (BSP) Developer's Guide. </para> <para> - Another example that illustrates a layer is an application. - Suppose you are creating an application that has library or other dependencies in - order for it to compile and run. - The layer, in this case, would be where all the recipes that define those dependencies - are kept. - The key point for a layer is that it is an isolated area that contains - all the relevant information for the project that the OpenEmbedded build + Another example that illustrates a layer is an application. + Suppose you are creating an application that has library or other dependencies in + order for it to compile and run. + The layer, in this case, would be where all the recipes that define those dependencies + are kept. + The key point for a layer is that it is an isolated area that contains + all the relevant information for the project that the OpenEmbedded build system knows about. - For more information on layers, see the + For more information on layers, see the "<link linkend='understanding-and-creating-layers'>Understanding and Creating Layers</link>" section. For more information on BSP layers, see the - "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" section in the + "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" section in the Yocto Project Board Support Package (BSP) Developer's Guide.</para> - <note>Four BSPs exist that are part of the + <note>Four BSPs exist that are part of the Yocto Project release: <filename>atom-pc</filename>, <filename>beagleboard</filename>, - <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>. - The recipes and configurations for these four BSPs are located and dispersed + <filename>mpc8315e</filename>, and <filename>routerstationpro</filename>. + The recipes and configurations for these four BSPs are located and dispersed within the <link linkend='source-directory'>Source Directory</link>. - On the other hand, BSP layers for Cedar Trail, Chief River, Crown Bay, - Crystal Forest, Emenlow, Fish River, Fish River 2, Jasper Forest, N450, - Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers + On the other hand, BSP layers for Cedar Trail, Chief River, Crown Bay, + Crystal Forest, Emenlow, Fish River, Fish River 2, Jasper Forest, N450, + Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers within the larger <filename>meta-intel</filename> layer.</note> - <para>When you set up a layer for a new BSP, you should follow a standard layout. + <para>When you set up a layer for a new BSP, you should follow a standard layout. This layout is described in the section "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>" - section of the Board Support Package (BSP) Development Guide. - In the standard layout, you will notice a suggested structure for recipes and - configuration information. - You can see the standard layout for a BSP by examining + section of the Board Support Package (BSP) Development Guide. + In the standard layout, you will notice a suggested structure for recipes and + configuration information. + You can see the standard layout for a BSP by examining any supported BSP found in the <filename>meta-intel</filename> layer inside the Source Directory.</para></listitem> - <listitem><para><emphasis>Make configuration changes to your new BSP - layer</emphasis>: The standard BSP layer structure organizes the files you need + <listitem><para><emphasis>Make configuration changes to your new BSP + layer</emphasis>: The standard BSP layer structure organizes the files you need to edit in <filename>conf</filename> and several <filename>recipes-*</filename> directories within the BSP layer. Configuration changes identify where your new layer is on the local system @@ -171,46 +171,46 @@ When you run the <filename>yocto-bsp</filename> script you are able to interactively configure many things for the BSP (e.g. keyboard, touchscreen, and so forth). </para></listitem> - <listitem><para><emphasis>Make recipe changes to your new BSP layer</emphasis>: Recipe - changes include altering recipes (<filename>.bb</filename> files), removing - recipes you don't use, and adding new recipes or append files + <listitem><para><emphasis>Make recipe changes to your new BSP layer</emphasis>: Recipe + changes include altering recipes (<filename>.bb</filename> files), removing + recipes you don't use, and adding new recipes or append files (<filename>.bbappend</filename>) that you need to support your hardware. </para></listitem> - <listitem><para><emphasis>Prepare for the build</emphasis>: Once you have made all the - changes to your BSP layer, there remains a few things - you need to do for the OpenEmbedded build system in order for it to create your image. - You need to get the build environment ready by sourcing an environment setup script + <listitem><para><emphasis>Prepare for the build</emphasis>: Once you have made all the + changes to your BSP layer, there remains a few things + you need to do for the OpenEmbedded build system in order for it to create your image. + You need to get the build environment ready by sourcing an environment setup script and you need to be sure two key configuration files are configured appropriately: - the <filename>conf/local.conf</filename> and the + the <filename>conf/local.conf</filename> and the <filename>conf/bblayers.conf</filename> file. You must make the OpenEmbedded build system aware of your new layer. - See the + See the "<link linkend='enabling-your-layer'>Enabling Your Layer</link>" section for information on how to let the build system know about your new layer.</para> <para>The entire process for building an image is overviewed in the section - "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section - of the Yocto Project Quick Start. + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section + of the Yocto Project Quick Start. You might want to reference this information.</para></listitem> - <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system - uses the BitBake tool to build images based on the type of image you want to create. - You can find more information about BitBake in the user manual, which is found in the - <filename>bitbake/doc/manual</filename> directory of the + <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system + uses the BitBake tool to build images based on the type of image you want to create. + You can find more information about BitBake in the user manual, which is found in the + <filename>bitbake/doc/manual</filename> directory of the <link linkend='source-directory'>Source Directory</link>.</para> - <para>The build process supports several types of images to satisfy different needs. - See the - "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter - in the Yocto Project Reference Manual for information on + <para>The build process supports several types of images to satisfy different needs. + See the + "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter + in the Yocto Project Reference Manual for information on supported images.</para></listitem> </orderedlist> </para> <para> You can view a video presentation on "Building Custom Embedded Images with Yocto" - at <ulink url='http://free-electrons.com/blog/elc-2011-videos'>Free Electrons</ulink>. - You can also find supplemental information in + at <ulink url='http://free-electrons.com/blog/elc-2011-videos'>Free Electrons</ulink>. + You can also find supplemental information in <ulink url='&YOCTO_DOCS_BSP_URL;'> The Board Support Package (BSP) Development Guide</ulink>. - Finally, there is wiki page write up of the example also located + Finally, there is wiki page write up of the example also located <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'> here</ulink> that you might find helpful. </para> @@ -221,7 +221,7 @@ <para> Kernel modification involves changing the Yocto Project kernel, which could involve changing - configuration options as well as adding new kernel recipes. + configuration options as well as adding new kernel recipes. Configuration changes can be added in the form of configuration fragments, while recipe modification comes through the kernel's <filename>recipes-kernel</filename> area in a kernel layer you create. @@ -232,10 +232,10 @@ kernel architecture and the steps to modify the kernel. For a complete discussion of the kernel, see the <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>. - You can reference the + You can reference the "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section for an example that changes the source code of the kernel. - For information on how to configure the kernel, see the + For information on how to configure the kernel, see the "<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section. </para> @@ -253,25 +253,25 @@ <para> You can find a web interface to the Yocto Project kernel source repositories at <ulink url='&YOCTO_GIT_URL;'></ulink>. - If you look at the interface, you will see to the left a grouping of - Git repositories titled "Yocto Linux Kernel." - Within this group, you will find several kernels supported by + If you look at the interface, you will see to the left a grouping of + Git repositories titled "Yocto Linux Kernel." + Within this group, you will find several kernels supported by the Yocto Project: <itemizedlist> - <listitem><para><emphasis><filename>linux-yocto-2.6.34</filename></emphasis> - The + <listitem><para><emphasis><filename>linux-yocto-2.6.34</filename></emphasis> - The stable Yocto Project kernel that is based on the Linux 2.6.34 released kernel.</para></listitem> <listitem><para><emphasis><filename>linux-yocto-2.6.37</filename></emphasis> - The stable Yocto Project kernel that is based on the Linux 2.6.37 released kernel.</para></listitem> <listitem><para><emphasis><filename>linux-yocto-3.0</filename></emphasis> - The stable Yocto Project kernel that is based on the Linux 3.0 released kernel.</para></listitem> - <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The - stable Yocto Project kernel to use with the Yocto Project Release 1.1.x. This kernel + <listitem><para><emphasis><filename>linux-yocto-3.0-1.1.x</filename></emphasis> - The + stable Yocto Project kernel to use with the Yocto Project Release 1.1.x. This kernel is based on the Linux 3.0 released kernel.</para></listitem> - <listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The - stable Yocto Project kernel to use with the Yocto Project Release 1.2. This kernel + <listitem><para><emphasis><filename>linux-yocto-3.2</filename></emphasis> - The + stable Yocto Project kernel to use with the Yocto Project Release 1.2. This kernel is based on the Linux 3.2 released kernel.</para></listitem> - <listitem><para><emphasis><filename>linux-yocto-3.4</filename></emphasis> - The - stable Yocto Project kernel to use with the Yocto Project Release 1.3. This kernel + <listitem><para><emphasis><filename>linux-yocto-3.4</filename></emphasis> - The + stable Yocto Project kernel to use with the Yocto Project Release 1.3. This kernel is based on the Linux 3.4 released kernel.</para></listitem> <listitem><para><emphasis><filename>linux-yocto-dev</filename></emphasis> - A development kernel based on the latest upstream release candidate available.</para></listitem> @@ -282,24 +282,24 @@ The kernels are maintained using the Git revision control system that structures them using the familiar "tree", "branch", and "leaf" scheme. Branches represent diversions from general code to more specific code, while leaves - represent the end-points for a complete and unique kernel whose source files + represent the end-points for a complete and unique kernel whose source files when gathered from the root of the tree to the leaf accumulate to create the files necessary for a specific piece of hardware and its features. The following figure displays this concept: <para> - <imagedata fileref="figures/kernel-overview-1.png" + <imagedata fileref="figures/kernel-overview-1.png" width="6in" depth="6in" align="center" scale="100" /> - </para> + </para> <para> Within the figure, the "Kernel.org Branch Point" represents the point in the tree where a supported base kernel is modified from the Linux kernel. For example, this could be the branch point for the <filename>linux-yocto-3.0</filename> kernel. - Thus, everything further to the right in the structure is based on the + Thus, everything further to the right in the structure is based on the <filename>linux-yocto-3.0</filename> kernel. - Branch points to right in the figure represent where the - <filename>linux-yocto-3.0</filename> kernel is modified for specific hardware + Branch points to right in the figure represent where the + <filename>linux-yocto-3.0</filename> kernel is modified for specific hardware or types of kernels, such as real-time kernels. Each leaf thus represents the end-point for a kernel designed to run on a specific targeted device. @@ -308,26 +308,26 @@ <para> The overall result is a Git-maintained repository from which all the supported kernel types can be derived for all the supported devices. - A big advantage to this scheme is the sharing of common features by keeping them in - "larger" branches within the tree. + A big advantage to this scheme is the sharing of common features by keeping them in + "larger" branches within the tree. This practice eliminates redundant storage of similar features shared among kernels. </para> <note> Keep in mind the figure does not take into account all the supported Yocto Project kernel types, but rather shows a single generic kernel just for conceptual purposes. - Also keep in mind that this structure represents the Yocto Project source repositories + Also keep in mind that this structure represents the Yocto Project source repositories that are either pulled from during the build or established on the host development system - prior to the build by either cloning a particular kernel's Git repository or by + prior to the build by either cloning a particular kernel's Git repository or by downloading and unpacking a tarball. </note> <para> - Upstream storage of all the available kernel source code is one thing, while - representing and using the code on your host development system is another. - Conceptually, you can think of the kernel source repositories as all the - source files necessary for all the supported kernels. - As a developer, you are just interested in the source files for the kernel on + Upstream storage of all the available kernel source code is one thing, while + representing and using the code on your host development system is another. + Conceptually, you can think of the kernel source repositories as all the + source files necessary for all the supported kernels. + As a developer, you are just interested in the source files for the kernel on on which you are working. And, furthermore, you need them available on your host system. </para> @@ -337,43 +337,43 @@ ways. If you are working in the kernel all the time, you probably would want to set up your own local Git repository of the kernel tree. - If you just need to make some patches to the kernel, you can get at + If you just need to make some patches to the kernel, you can get at temporary kernel source files extracted and used during the OpenEmbedded - build system. + build system. We will just talk about working with the temporary source code. </para> <para> - What happens during the build? + What happens during the build? When you build the kernel on your development system, all files needed for the build - are taken from the source repositories pointed to by the - <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable + are taken from the source repositories pointed to by the + <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable and gathered in a temporary work area where they are subsequently used to create the unique kernel. - Thus, in a sense, the process constructs a local source tree specific to your + Thus, in a sense, the process constructs a local source tree specific to your kernel to generate the new kernel image - a source generator if you will. </para> The following figure shows the temporary file structure - created on your host system when the build occurs. - This - <link linkend='build-directory'>Build Directory</link> contains all the + created on your host system when the build occurs. + This + <link linkend='build-directory'>Build Directory</link> contains all the source files used during the build. </para> <para> - <imagedata fileref="figures/kernel-overview-2-generic.png" + <imagedata fileref="figures/kernel-overview-2-generic.png" width="6in" depth="5in" align="center" scale="100" /> - </para> + </para> <para> - Again, for a complete discussion of the Yocto Project kernel's architecture and its + Again, for a complete discussion of the Yocto Project kernel's architecture and its branching strategy, see the <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>. You can also reference the "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section for a detailed example that modifies the kernel. </para> - </section> + </section> <section id='kernel-modification-workflow'> <title>Kernel Modification Workflow</title> @@ -383,73 +383,73 @@ </para> <para> - <imagedata fileref="figures/kernel-dev-flow.png" + <imagedata fileref="figures/kernel-dev-flow.png" width="6in" depth="5in" align="center" scalefit="1" /> - </para> + </para> <para> <orderedlist> - <listitem><para><emphasis>Set up your host development system to support - development using the Yocto Project</emphasis>: See - "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and + <listitem><para><emphasis>Set up your host development system to support + development using the Yocto Project</emphasis>: See + "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both in the Yocto Project Quick Start for requirements.</para></listitem> - <listitem><para><emphasis>Establish a local copy of project files on your + <listitem><para><emphasis>Establish a local copy of project files on your system</emphasis>: Having the <link linkend='source-directory'>Source - Directory</link> on your system gives you access to the build process and tools + Directory</link> on your system gives you access to the build process and tools you need. For information on how to get these files, see the bulleted item "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual. </para></listitem> - <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>: - Temporary kernel source files are kept in the Build Directory created by the + <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>: + Temporary kernel source files are kept in the Build Directory created by the OpenEmbedded build system when you run BitBake. - If you have never built the kernel you are interested in, you need to run + If you have never built the kernel you are interested in, you need to run an initial build to establish local kernel source files.</para> - <para>If you are building an image for the first time, you need to get the build - environment ready by sourcing + <para>If you are building an image for the first time, you need to get the build + environment ready by sourcing the environment setup script. - You also need to be sure two key configuration files + You also need to be sure two key configuration files (<filename>local.conf</filename> and <filename>bblayers.conf</filename>) are configured appropriately.</para> - <para>The entire process for building an image is overviewed in the - "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" - section of the Yocto Project Quick Start. + <para>The entire process for building an image is overviewed in the + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" + section of the Yocto Project Quick Start. You might want to reference this information. You can find more information on BitBake in the user manual, which is found in the - <filename>bitbake/doc/manual</filename> directory of the + <filename>bitbake/doc/manual</filename> directory of the <link linkend='source-directory'>Source Directory</link>.</para> - <para>The build process supports several types of images to satisfy different needs. - See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in + <para>The build process supports several types of images to satisfy different needs. + See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in the Yocto Project Reference Manual for information on supported images. </para></listitem> - <listitem><para><emphasis>Make changes to the kernel source code if + <listitem><para><emphasis>Make changes to the kernel source code if applicable</emphasis>: Modifying the kernel does not always mean directly - changing source files. - However, if you have to do this, you make the changes to the files in the - Build directory.</para></listitem> + changing source files. + However, if you have to do this, you make the changes to the files in the + Build directory.</para></listitem> <listitem><para><emphasis>Make kernel configuration changes - if applicable</emphasis>: - If your situation calls for changing the kernel's configuration, you can + if applicable</emphasis>: + If your situation calls for changing the kernel's configuration, you can use the <filename>yocto-kernel</filename> script or <filename>menuconfig</filename> - to enable and disable kernel configurations. + to enable and disable kernel configurations. Using the script lets you interactively set up kernel configurations. - Using <filename>menuconfig</filename> allows you to interactively develop and test the + Using <filename>menuconfig</filename> allows you to interactively develop and test the configuration changes you are making to the kernel. When saved, changes using <filename>menuconfig</filename> update the kernel's <filename>.config</filename>. - Try to resist the temptation of directly editing the <filename>.config</filename> - file found in the - <link linkend='build-directory'>Build Directory</link> at + Try to resist the temptation of directly editing the <filename>.config</filename> + file found in the + <link linkend='build-directory'>Build Directory</link> at <filename>tmp/sysroots/<machine-name>/kernel</filename>. - Doing so, can produce unexpected results when the OpenEmbedded build system + Doing so, can produce unexpected results when the OpenEmbedded build system regenerates the configuration file.</para> - <para>Once you are satisfied with the configuration changes made using - <filename>menuconfig</filename>, you can directly examine the + <para>Once you are satisfied with the configuration changes made using + <filename>menuconfig</filename>, you can directly examine the <filename>.config</filename> file against a saved original and gather those - changes into a config fragment to be referenced from within the kernel's - <filename>.bbappend</filename> file.</para></listitem> - <listitem><para><emphasis>Rebuild the kernel image with your changes</emphasis>: + changes into a config fragment to be referenced from within the kernel's + <filename>.bbappend</filename> file.</para></listitem> + <listitem><para><emphasis>Rebuild the kernel image with your changes</emphasis>: Rebuilding the kernel image applies your changes.</para></listitem> </orderedlist> </para> @@ -461,23 +461,23 @@ <title>Application Development Workflow</title> <para> - Application development involves creating an application that you want - to run on your target hardware, which is running a kernel image created using the + Application development involves creating an application that you want + to run on your target hardware, which is running a kernel image created using the OpenEmbedded build system. - The Yocto Project provides an Application Development Toolkit (ADT) and - stand-alone cross-development toolchains that - facilitate quick development and integration of your application into its run-time environment. - Using the ADT and toolchains, you can compile and link your application. + The Yocto Project provides an Application Development Toolkit (ADT) and + stand-alone cross-development toolchains that + facilitate quick development and integration of your application into its run-time environment. + Using the ADT and toolchains, you can compile and link your application. You can then deploy your application to the actual hardware or to the QEMU emulator for testing. - If you are familiar with the popular <trademark class='trade'>Eclipse</trademark> IDE, - you can use an Eclipse Yocto Plug-in to + If you are familiar with the popular <trademark class='trade'>Eclipse</trademark> IDE, + you can use an Eclipse Yocto Plug-in to allow you to develop, deploy, and test your application all from within Eclipse. </para> <para> - While we strongly suggest using the ADT to develop your application, this option might not - be best for you. - If this is the case, you can still use pieces of the Yocto Project for your development process. + While we strongly suggest using the ADT to develop your application, this option might not + be best for you. + If this is the case, you can still use pieces of the Yocto Project for your development process. However, because the process can vary greatly, this manual does not provide detail on the process. </para> @@ -485,8 +485,8 @@ <title>Workflow Using the ADT and <trademark class='trade'>Eclipse</trademark></title> <para> - To help you understand how application development works using the ADT, this section - provides an overview of the general development process and a detailed example of the process + To help you understand how application development works using the ADT, this section + provides an overview of the general development process and a detailed example of the process as it is used from within the Eclipse IDE. </para> @@ -495,94 +495,94 @@ </para> <para> - <imagedata fileref="figures/app-dev-flow.png" + <imagedata fileref="figures/app-dev-flow.png" width="7in" depth="8in" align="center" scale="100" /> - </para> + </para> <para> <orderedlist> - <listitem><para><emphasis>Prepare the Host System for the Yocto Project</emphasis>: - See - "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and + <listitem><para><emphasis>Prepare the Host System for the Yocto Project</emphasis>: + See + "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distributions</ulink>" and "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both in the Yocto Project Quick Start for requirements.</para></listitem> - <listitem><para><emphasis>Secure the Yocto Project Kernel Target Image</emphasis>: + <listitem><para><emphasis>Secure the Yocto Project Kernel Target Image</emphasis>: You must have a target kernel image that has been built using the OpenEmbeded build system.</para> <para>Depending on whether the Yocto Project has a pre-built image that matches your target architecture and where you are going to run the image while you develop your application (QEMU or real hardware), the area from which you get the image differs. <itemizedlist> - <listitem><para>Download the image from + <listitem><para>Download the image from <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink> - if your target architecture is supported and you are going to develop + if your target architecture is supported and you are going to develop and test your application on actual hardware.</para></listitem> - <listitem><para>Download the image from the - <ulink url='&YOCTO_QEMU_DL_URL;'> + <listitem><para>Download the image from the + <ulink url='&YOCTO_QEMU_DL_URL;'> <filename>machines/qemu</filename></ulink> if your target architecture is supported - and you are going to develop and test your application using the QEMU + and you are going to develop and test your application using the QEMU emulator.</para></listitem> <listitem><para>Build your image if you cannot find a pre-built image that matches your target architecture. - If your target architecture is similar to a supported architecture, you can + If your target architecture is similar to a supported architecture, you can modify the kernel image before you build it. - See the + See the "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section for an example.</para></listitem> </itemizedlist></para> - <para>For information on pre-built kernel image naming schemes for images + <para>For information on pre-built kernel image naming schemes for images that can run on the QEMU emulator, see the "<ulink url='&YOCTO_DOCS_QS_URL;#downloading-the-pre-built-linux-kernel'>Downloading the Pre-Built Linux Kernel</ulink>" section in the Yocto Project Quick Start.</para></listitem> - <listitem><para><emphasis>Install the ADT</emphasis>: + <listitem><para><emphasis>Install the ADT</emphasis>: The ADT provides a target-specific cross-development toolchain, the root filesystem, the QEMU emulator, and other tools that can help you develop your application. - While it is possible to get these pieces separately, the ADT Installer provides an + While it is possible to get these pieces separately, the ADT Installer provides an easy method. You can get these pieces by running an ADT installer script, which is configurable. For information on how to install the ADT, see the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Using the ADT Installer</ulink>" - section + section in the Yocto Project Application Developer's Guide.</para></listitem> - <listitem><para><emphasis>If Applicable, Secure the Target Root Filesystem - and the Cross-development Toolchain</emphasis>: + <listitem><para><emphasis>If Applicable, Secure the Target Root Filesystem + and the Cross-development Toolchain</emphasis>: If you choose not to install the ADT using the ADT Installer, - you need to find and download the appropriate root filesystem and + you need to find and download the appropriate root filesystem and the cross-development toolchain.</para> - <para>You can find the tarballs for the root filesystem in the same area used + <para>You can find the tarballs for the root filesystem in the same area used for the kernel image. - Depending on the type of image you are running, the root filesystem you need differs. - For example, if you are developing an application that runs on an image that + Depending on the type of image you are running, the root filesystem you need differs. + For example, if you are developing an application that runs on an image that supports Sato, you need to get root filesystem that supports Sato.</para> <para>You can find the cross-development toolchains at <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'><filename>toolchains</filename></ulink>. - Be sure to get the correct toolchain for your development host and your + Be sure to get the correct toolchain for your development host and your target architecture. See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" - section in the Yocto Project Application Developer's Guide for information - and the + section in the Yocto Project Application Developer's Guide for information + and the "<ulink url='&YOCTO_DOCS_QS_URL;#installing-the-toolchain'>Installing the Toolchain</ulink>" - in the Yocto Project Quick Start for information on finding and installing + in the Yocto Project Quick Start for information on finding and installing the correct toolchain based on your host development system and your target architecture. </para></listitem> - <listitem><para><emphasis>Create and Build your Application</emphasis>: + <listitem><para><emphasis>Create and Build your Application</emphasis>: At this point, you need to have source files for your application. - Once you have the files, you can use the Eclipse IDE to import them and build the - project. - If you are not using Eclipse, you need to use the cross-development tools you have - installed to create the image.</para></listitem> - <listitem><para><emphasis>Deploy the Image with the Application</emphasis>: - If you are using the Eclipse IDE, you can deploy your image to the hardware or to - QEMU through the project's preferences. - If you are not using the Eclipse IDE, then you need to deploy the application + Once you have the files, you can use the Eclipse IDE to import them and build the + project. + If you are not using Eclipse, you need to use the cross-development tools you have + installed to create the image.</para></listitem> + <listitem><para><emphasis>Deploy the Image with the Application</emphasis>: + If you are using the Eclipse IDE, you can deploy your image to the hardware or to + QEMU through the project's preferences. + If you are not using the Eclipse IDE, then you need to deploy the application to the hardware using other methods. - Or, if you are using QEMU, you need to use that tool and load your image in for testing. - </para></listitem> - <listitem><para><emphasis>Test and Debug the Application</emphasis>: + Or, if you are using QEMU, you need to use that tool and load your image in for testing. + </para></listitem> + <listitem><para><emphasis>Test and Debug the Application</emphasis>: Once your application is deployed, you need to test it. - Within the Eclipse IDE, you can use the debugging environment along with the - set of user-space tools installed along with the ADT to debug your application. + Within the Eclipse IDE, you can use the debugging environment along with the + set of user-space tools installed along with the ADT to debug your application. Of course, the same user-space tools are available separately if you choose not to use the Eclipse IDE.</para></listitem> </orderedlist> @@ -593,7 +593,7 @@ <title>Working Within Eclipse</title> <para> - The Eclipse IDE is a popular development environment and it fully supports + The Eclipse IDE is a popular development environment and it fully supports development using the Yocto Project. <note>This release of the Yocto Project supports both the Juno and Indigo versions of the Eclipse IDE. @@ -601,21 +601,21 @@ </note> </para> - <para> - When you install and configure the Eclipse Yocto Project Plug-in into - the Eclipse IDE, you maximize your Yocto Project experience. - Installing and configuring the Plug-in results in an environment that - has extensions specifically designed to let you more easily develop software. - These extensions allow for cross-compilation, deployment, and execution of - your output into a QEMU emulation session. - You can also perform cross-debugging and profiling. - The environment also supports a suite of tools that allows you to perform - remote profiling, tracing, collection of power data, collection of + <para> + When you install and configure the Eclipse Yocto Project Plug-in into + the Eclipse IDE, you maximize your Yocto Project experience. + Installing and configuring the Plug-in results in an environment that + has extensions specifically designed to let you more easily develop software. + These extensions allow for cross-compilation, deployment, and execution of + your output into a QEMU emulation session. + You can also perform cross-debugging and profiling. + The environment also supports a suite of tools that allows you to perform + remote profiling, tracing, collection of power data, collection of latency data, and collection of performance data. </para> <para> - This section describes how to install and configure the Eclipse IDE + This section describes how to install and configure the Eclipse IDE Yocto Plug-in and how to use it to develop your application. </para> @@ -641,10 +641,10 @@ <title>Installing the Eclipse IDE</title> <para> - It is recommended that you have the Juno 4.2 version of the - Eclipse IDE installed on your development system. - However, if you currently have the Indigo 3.7.2 version installed and you do - not want to upgrade the IDE, you can configure Indigo to work with the + It is recommended that you have the Juno 4.2 version of the + Eclipse IDE installed on your development system. + However, if you currently have the Indigo 3.7.2 version installed and you do + not want to upgrade the IDE, you can configure Indigo to work with the Yocto Project. See the "<link linkend='configuring-the-eclipse-ide-indigo'>Configuring the Eclipse IDE (Indigo)</link>" @@ -652,19 +652,19 @@ </para> <para> - If you don’t have the Juno 4.2 Eclipse IDE installed, you can find the tarball at - <ulink url='&ECLIPSE_MAIN_URL;'></ulink>. + If you don’t have the Juno 4.2 Eclipse IDE installed, you can find the tarball at + <ulink url='&ECLIPSE_MAIN_URL;'></ulink>. From that site, choose the Eclipse Classic version particular to your development - host. - This version contains the Eclipse Platform, the Java Development + host. + This version contains the Eclipse Platform, the Java Development Tools (JDT), and the Plug-in Development Environment. </para> <para> - Once you have downloaded the tarball, extract it into a clean + Once you have downloaded the tarball, extract it into a clean directory. - For example, the following commands unpack and install the - downloaded Eclipse IDE tarball into a clean directory + For example, the following commands unpack and install the + downloaded Eclipse IDE tarball into a clean directory using the default name <filename>eclipse</filename>: <literallayout class='monospaced'> $ cd ~ @@ -674,12 +674,12 @@ <para> If you have the Indigo 3.7.2 Eclipse IDE already installed and you want to use that - version, one issue exists that you need to be aware of regarding the Java - Virtual machine’s garbage collection (GC) process. - The GC process does not clean up the permanent generation - space (PermGen). - This space stores metadata descriptions of classes. - The default value is set too small and it could trigger an + version, one issue exists that you need to be aware of regarding the Java + Virtual machine’s garbage collection (GC) process. + The GC process does not clean up the permanent generation + space (PermGen). + This space stores metadata descriptions of classes. + The default value is set too small and it could trigger an out-of-memory error such as the following: <literallayout class='monospaced'> Java.lang.OutOfMemoryError: PermGen space @@ -692,7 +692,7 @@ <para> To fix this issue, you can use the <filename>--vmargs</filename> - option when you start the Indigo 3.7.2 Eclipse IDE + option when you start the Indigo 3.7.2 Eclipse IDE to increase the size of the permanent generation space: <literallayout class='monospaced'> eclipse --vmargs --XX:PermSize=256M @@ -705,24 +705,24 @@ <para> This section presents the steps needed to configure the Juno 4.2 Eclipse IDE. - If you are using Indigo 3.7.2, see the + If you are using Indigo 3.7.2, see the "<link linkend='configuring-the-eclipse-ide-indigo'>Configuring the Eclipse IDE (Indigo)</link>". </para> <para> Before installing and configuring the Eclipse Yocto Plug-in, you need to configure - the Juno 4.2 Eclipse IDE. + the Juno 4.2 Eclipse IDE. Follow these general steps: <orderedlist> <listitem><para>Start the Eclipse IDE.</para></listitem> - <listitem><para>Make sure you are in your Workbench and select + <listitem><para>Make sure you are in your Workbench and select "Install New Software" from the "Help" pull-down menu. </para></listitem> <listitem><para>Select <filename>Juno - &ECLIPSE_JUNO_URL;</filename> from the "Work with:" pull-down menu.</para></listitem> - <listitem><para>Expand the box next to "Linux Tools" and select the + <listitem><para>Expand the box next to "Linux Tools" and select the "LTTng - Linux Tracing Toolkit" boxes.</para></listitem> - <listitem><para>Expand the box next to "Mobile and Device Development" and select the + <listitem><para>Expand the box next to "Mobile and Device Development" and select the following boxes: <itemizedlist> <listitem><para><filename>C/C++ Remote Launch</filename></para></listitem> @@ -745,17 +745,17 @@ <para> This section presents the steps needed to configure the Indigo 3.7.2 Eclipse IDE. - If you are using Juno 4.2, see the + If you are using Juno 4.2, see the "<link linkend='configuring-the-eclipse-ide-juno'>Configuring the Eclipse IDE (Juno)</link>". </para> <para> Before installing and configuring the Eclipse Yocto Plug-in, you need to configure - the Indigo 3.7.2 Eclipse IDE. + the Indigo 3.7.2 Eclipse IDE. Follow these general steps: <orderedlist> <listitem><para>Start the Eclipse IDE.</para></listitem> - <listitem><para>Make sure you are in your Workbench and select + <listitem><para>Make sure you are in your Workbench and select "Install New Software" from the "Help" pull-down menu. </para></listitem> <listitem><para>Select <filename>indigo - &ECLIPSE_INDIGO_URL;</filename> @@ -763,14 +763,14 @@ <listitem><para>Expand the box next to <filename>Programming Languages</filename> and select the <filename>Autotools Support for CDT (incubation)</filename> and <filename>C/C++ Development Tools</filename> boxes.</para></listitem> - <listitem><para>Expand the box next to "Linux Tools" and select the + <listitem><para>Expand the box next to "Linux Tools" and select the "LTTng - Linux Tracing Toolkit(incubation)" boxes.</para></listitem> <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> - <listitem><para>After the Eclipse IDE restarts and from the Workbench, select + <listitem><para>After the Eclipse IDE restarts and from the Workbench, select "Install New Software" from the "Help" pull-down menu.</para></listitem> - <listitem><para>Click the + <listitem><para>Click the "Available Software Sites" link.</para></listitem> - <listitem><para>Check the box next to + <listitem><para>Check the box next to <filename>&ECLIPSE_UPDATES_URL;</filename> and click "OK".</para></listitem> <listitem><para>Select <filename>&ECLIPSE_UPDATES_URL;</filename> @@ -778,13 +778,13 @@ <listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>. </para></listitem> <listitem><para>Expand the box next to <filename>TM and RSE Optional Add-ons</filename> - and select every item except <filename>RSE Unit Tests</filename> and + and select every item except <filename>RSE Unit Tests</filename> and <filename>RSE WinCE Services (incubation)</filename>.</para></listitem> <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> - <listitem><para>If necessary, select - "Install New Software" from the "Help" pull-down menu so you can click the + <listitem><para>If necessary, select + "Install New Software" from the "Help" pull-down menu so you can click the "Available Software Sites" link again.</para></listitem> - <listitem><para>After clicking "Available Software Sites", check the box next to + <listitem><para>After clicking "Available Software Sites", check the box next to <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename> and click "OK".</para></listitem> <listitem><para>Select <filename>&ECLIPSE_INDIGO_CDT_URL;</filename> @@ -792,7 +792,7 @@ <listitem><para>Check the box next to <filename>CDT Main Features</filename>. </para></listitem> <listitem><para>Expand the box next to <filename>CDT Optional Features</filename> - and select <filename>C/C++ Remote Launch</filename> and + and select <filename>C/C++ Remote Launch</filename> and <filename>Target Communication Framework (incubation)</filename>.</para></listitem> <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> </orderedlist> @@ -807,7 +807,7 @@ one of two ways: use the Yocto Project's Eclipse Update site to install the pre-built plug-in, or build and install the plug-in from the latest source code. If you don't want to permanently install the plug-in but just want to try it out - within the Eclipse environment, you can import the plug-in project from the + within the Eclipse environment, you can import the plug-in project from the Yocto Project's Source Repositories. </para> @@ -815,22 +815,22 @@ <title>Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site</title> <para> - To install the Eclipse Yocto Plug-in from the update site, + To install the Eclipse Yocto Plug-in from the update site, follow these steps: <orderedlist> <listitem><para>Start up the Eclipse IDE.</para></listitem> <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem> <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem> - <listitem><para>Enter - <filename>&ECLIPSE_DL_PLUGIN_URL;</filename> + <listitem><para>Enter + <filename>&ECLIPSE_DL_PLUGIN_URL;</filename> in the URL field and provide a meaningful name in the "Name" field.</para></listitem> - <listitem><para>Click "OK" to have the entry added to the "Work with:" + <listitem><para>Click "OK" to have the entry added to the "Work with:" drop-down list.</para></listitem> - <listitem><para>Select the entry for the plug-in from the "Work with:" drop-down + <listitem><para>Select the entry for the plug-in from the "Work with:" drop-down list.</para></listitem> <listitem><para>Check the box next to <filename>Development tools and SDKs for Yocto Linux</filename>. </para></listitem> - <listitem><para>Complete the remaining software installation steps and + <listitem><para>Complete the remaining software installation steps and then restart the Eclipse IDE to finish the installation of the plug-in. </para></listitem> </orderedlist> @@ -839,7 +839,7 @@ <section id='zip-file-method'> <title>Installing the Plug-in Using the Latest Source Code</title> - + <para> To install the Eclipse Yocto Plug-in from the latest source code, follow these steps: <orderedlist> @@ -847,9 +847,9 @@ <literallayout class='monospaced'> $ git clone git://git.yoctoproject.org/eclipse-poky yocto-eclipse </literallayout> - For this example, the repository is named + For this example, the repository is named <filename>~/yocto-eclipse</filename>.</para></listitem> - <listitem><para>Change to the directory where you set up + <listitem><para>Change to the directory where you set up the Git repository: <literallayout class='monospaced'> $ cd ~/yocto-eclipse @@ -864,38 +864,38 @@ <literallayout class='monospaced'> $ cd scripts </literallayout></para></listitem> - <listitem><para>Set up the local build environment by running the + <listitem><para>Set up the local build environment by running the setup script: <literallayout class='monospaced'> $ ./setup.sh </literallayout></para></listitem> <listitem><para>When the script finishes execution, it prompts - you with instructions on how to run the - <filename>build.sh</filename> script, which is also in - the <filename>scripts</filename> of the + you with instructions on how to run the + <filename>build.sh</filename> script, which is also in + the <filename>scripts</filename> of the Git repository created earlier. </para></listitem> <listitem><para>Run the <filename>build.sh</filename> script - as directed. - Be sure to provide the name of the Git branch along with the + as directed. + Be sure to provide the name of the Git branch along with the Yocto Project release you are using. Here is an example that uses the <filename>&DISTRO_NAME;</filename> branches: <literallayout class='monospaced'> - $ ECLIPSE_HOME=/home/scottrif/yocto-eclipse/scripts/eclipse ./build.sh &DISTRO_NAME; &DISTRO_NAME; + $ ECLIPSE_HOME=/home/scottrif/yocto-eclipse/scripts/eclipse ./build.sh &DISTRO_NAME; &DISTRO_NAME; </literallayout> After running the script, the file <filename>org.yocto.sdk-<release>-<date>-archive.zip</filename> is in the current directory.</para></listitem> - <listitem><para>If necessary, start the Eclipse IDE and be sure you are in the + <listitem><para>If necessary, start the Eclipse IDE and be sure you are in the Workbench.</para></listitem> <listitem><para>Select "Install New Software" from the "Help" pull-down menu. </para></listitem> <listitem><para>Click "Add".</para></listitem> <listitem><para>Provide anything you want in the "Name" field.</para></listitem> - <listitem><para>Click "Archive" and browse to the ZIP file you built - in step seven. - This ZIP file should not be "unzipped", and must be the - <filename>*archive.zip</filename> file created by running the + <listitem><para>Click "Archive" and browse to the ZIP file you built + in step seven. + This ZIP file should not be "unzipped", and must be the + <filename>*archive.zip</filename> file created by running the <filename>build.sh</filename> script.</para></listitem> <listitem><para>Click through the "Okay" buttons.</para></listitem> <listitem><para>Check the box next to the new entry in the installation window and complete @@ -908,16 +908,16 @@ At this point you should be able to configure the Eclipse Yocto Plug-in as described in the "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" section.</para> - </section> + </section> <section id='yocto-project-source'> <title>Importing the Plug-in Project into the Eclipse Environment</title> <para> Importing the Eclipse Yocto Plug-in project from the Yocto Project source repositories - is useful when you want to try out the latest plug-in from the tip of plug-in's + is useful when you want to try out the latest plug-in from the tip of plug-in's development tree. - It is important to understand when you import the plug-in you are not installing + It is important to understand when you import the plug-in you are not installing it into the Eclipse application. Rather, you are importing the project and just using it. To import the plug-in project, follow these steps: @@ -926,21 +926,21 @@ <literallayout class='monospaced'> $ git clone git://git.yoctoproject.org/eclipse-poky yocto-eclipse </literallayout> - For this example, the repository is named + For this example, the repository is named <filename>~/yocto-eclipse</filename>.</para></listitem> <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem> <listitem><para>Expand the "General" box and select "existing projects into workspace" and then click "Next".</para></listitem> - <listitem><para>Select the root directory and browse to + <listitem><para>Select the root directory and browse to <filename>~/yocto-eclipse/plugins</filename>.</para></listitem> <listitem><para>Three plug-ins exist: "org.yocto.bc.ui", "org.yocto.sdk.ide", and - "org.yocto.sdk.remotetools". + "org.yocto.sdk.remotetools". Select and import all of them.</para></listitem> </orderedlist> </para> <para> - The left navigation pane in the Eclipse application shows the default projects. + The left navigation pane in the Eclipse application shows the default projects. Right-click on one of these projects and run it as an Eclipse application. This brings up a second instance of Eclipse IDE that has the Yocto Plug-in. </para> @@ -951,17 +951,17 @@ <title>Configuring the Eclipse Yocto Plug-in</title> <para> - Configuring the Eclipse Yocto Plug-in involves setting the Cross - Compiler options and the Target options. - The configurations you choose become the default settings for all projects. - You do have opportunities to change them later when - you configure the project (see the following section). + Configuring the Eclipse Yocto Plug-in involves setting the Cross + Compiler options and the Target options. + The configurations you choose become the default settings for all projects. + You do have opportunities to change them later when + you configure the project (see the following section). </para> <para> To start, you need to do the following from within the Eclipse IDE: <itemizedlist> - <listitem><para>Choose <filename>Windows -> Preferences</filename> to display + <listitem><para>Choose <filename>Windows -> Preferences</filename> to display the <filename>Preferences</filename> Dialog</para></listitem> <listitem><para>Click <filename>Yocto Project ADT</filename></para></listitem> </itemizedlist> @@ -976,23 +976,23 @@ <itemizedlist> <listitem><para><emphasis>Selecting the Toolchain Type:</emphasis> Choose between <filename>Standalone pre-built toolchain</filename> - and <filename>Build system derived toolchain</filename> for Cross + and <filename>Build system derived toolchain</filename> for Cross Compiler Options. <itemizedlist> <listitem><para><emphasis> - <filename>Standalone Pre-built Toolchain:</filename></emphasis> + <filename>Standalone Pre-built Toolchain:</filename></emphasis> Select this mode when you are using a stand-alone cross-toolchain. - For example, suppose you are an application developer and do not + For example, suppose you are an application developer and do not need to build a target image. - Instead, you just want to use an architecture-specific toolchain on an + Instead, you just want to use an architecture-specific toolchain on an existing kernel and target root filesystem. </para></listitem> <listitem><para><emphasis> - <filename>Build System Derived Toolchain:</filename></emphasis> - Select this mode if the cross-toolchain has been installed and built - as part of the Build Directory. + <filename>Build System Derived Toolchain:</filename></emphasis> + Select this mode if the cross-toolchain has been installed and built + as part of the Build Directory. When you select <filename>Build system derived toolchain</filename>, - you are using the toolchain bundled + you are using the toolchain bundled inside the Build Directory. </para></listitem> </itemizedlist> @@ -1001,44 +1001,44 @@ If you are using a stand-alone pre-built toolchain, you should be pointing to the <filename>&YOCTO_ADTPATH_DIR;</filename> directory. This is the location for toolchains installed by the ADT Installer or by hand. - Sections "<ulink url='&YOCTO_DOCS_ADT_URL;#configuring-and-running-the-adt-installer-script'>Configuring - and Running the ADT Installer Script</ulink>" and - "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" - in the Yocto Project Application Developer's Guide - describe two ways to install a stand-alone cross-toolchain in the + Sections "<ulink url='&YOCTO_DOCS_ADT_URL;#configuring-and-running-the-adt-installer-script'>Configuring + and Running the ADT Installer Script</ulink>" and + "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" + in the Yocto Project Application Developer's Guide + describe two ways to install a stand-alone cross-toolchain in the <filename>/opt/poky</filename> directory. <note>It is possible to install a stand-alone cross-toolchain in a directory other than <filename>/opt/poky</filename>. However, doing so is discouraged.</note></para> - <para>If you are using a system-derived toolchain, the path you provide + <para>If you are using a system-derived toolchain, the path you provide for the <filename>Toolchain Root Location</filename> field is the Build Directory. - See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using + See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Build Directory</ulink>" section in the Yocto Project Application - Developer's Guide for information on how to install the toolchain into the build -directory.</para></listitem> + Developer's Guide for information on how to install the toolchain into the build +directory.</para></listitem> <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> - This location is where the root filesystem for the target hardware resides. - If you used the ADT Installer, then the location is + This location is where the root filesystem for the target hardware resides. + If you used the ADT Installer, then the location is <filename>/opt/poky/<release></filename>. - Additionally, when you use the ADT Installer, the same location is used for + Additionally, when you use the ADT Installer, the same location is used for the QEMU user-space tools and the NFS boot process.</para> - <para>If you used either of the other two methods to install the toolchain, then the + <para>If you used either of the other two methods to install the toolchain, then the location of the sysroot filesystem depends on where you separately extracted and intalled the filesystem.</para> - <para>For information on how to install the toolchain and on how to extract + <para>For information on how to install the toolchain and on how to extract and install the sysroot filesystem, see the "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>" section. </para></listitem> <listitem><para><emphasis>Select the Target Architecture:</emphasis> - The target architecture is the type of hardware you are + The target architecture is the type of hardware you are going to use or emulate. Use the pull-down <filename>Target Architecture</filename> menu to make your selection. - The pull-down menu should have the supported architectures. - If the architecture you need is not listed in the menu, you + The pull-down menu should have the supported architectures. + If the architecture you need is not listed in the menu, you will need to build the image. - See the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section + See the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start for more information.</para></listitem> </itemizedlist> </para> @@ -1048,37 +1048,37 @@ directory.</para></listitem> <title>Configuring the Target Options</title> <para> - You can choose to emulate hardware using the QEMU emulator, or you + You can choose to emulate hardware using the QEMU emulator, or you can choose to run your image on actual hardware. <itemizedlist> - <listitem><para><emphasis><filename>QEMU:</filename></emphasis> Select this option if - you will be using the QEMU emulator. - If you are using the emulator, you also need to locate the kernel + <listitem><para><emphasis><filename>QEMU:</filename></emphasis> Select this option if + you will be using the QEMU emulator. + If you are using the emulator, you also need to locate the kernel and specify any custom options.</para> - <para>If you selected <filename>Build system derived toolchain</filename>, - the target kernel you built will be located in the - Build Directory in <filename>tmp/deploy/images</filename> directory. - If you selected <filename>Standalone pre-built toolchain</filename>, the - pre-built image you downloaded is located + <para>If you selected <filename>Build system derived toolchain</filename>, + the target kernel you built will be located in the + Build Directory in <filename>tmp/deploy/images</filename> directory. + If you selected <filename>Standalone pre-built toolchain</filename>, the + pre-built image you downloaded is located in the directory you specified when you downloaded the image.</para> - <para>Most custom options are for advanced QEMU users to further - customize their QEMU instance. - These options are specified between paired angled brackets. + <para>Most custom options are for advanced QEMU users to further + customize their QEMU instance. + These options are specified between paired angled brackets. Some options must be specified outside the brackets. - In particular, the options <filename>serial</filename>, - <filename>nographic</filename>, and <filename>kvm</filename> must all - be outside the brackets. + In particular, the options <filename>serial</filename>, + <filename>nographic</filename>, and <filename>kvm</filename> must all + be outside the brackets. Use the <filename>man qemu</filename> command to get help on all the options - and their use. + and their use. The following is an example: <literallayout class='monospaced'> serial ‘<-m 256 -full-screen>’ </literallayout></para> <para> - Regardless of the mode, Sysroot is already defined as part of the - Cross Compiler Options configuration in the + Regardless of the mode, Sysroot is already defined as part of the + Cross Compiler Options configuration in the <filename>Sysroot Location:</filename> field.</para></listitem> - <listitem><para><emphasis><filename>External HW:</filename></emphasis> Select this option + <listitem><para><emphasis><filename>External HW:</filename></emphasis> Select this option if you will be using actual hardware.</para></listitem> </itemizedlist> </para> @@ -1094,23 +1094,23 @@ directory.</para></listitem> <title>Creating the Project</title> <para> - You can create two types of projects: Autotools-based, or Makefile-based. - This section describes how to create Autotools-based projects from within - the Eclipse IDE. + You can create two types of projects: Autotools-based, or Makefile-based. + This section describes how to create Autotools-based projects from within + the Eclipse IDE. For information on creating Makefile-based projects in a terminal window, see the section "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-command-line'>Using the Command Line</ulink>" in the Yocto Project Application Developer's Guide. </para> <para> - To create a project based on a Yocto template and then display the source code, + To create a project based on a Yocto template and then display the source code, follow these steps: <orderedlist> <listitem><para>Select <filename>File -> New -> Project</filename>.</para></listitem> <listitem><para>Double click <filename>CC++</filename>.</para></listitem> <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem> <listitem><para>Expand <filename>Yocto Project ADT Project</filename>.</para></listitem> - <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. + <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. This is an Autotools-based project based on a Yocto template.</para></listitem> <listitem><para>Put a name in the <filename>Project name:</filename> field. Do not use hyphens as part of the name.</para></listitem> @@ -1119,7 +1119,7 @@ directory.</para></listitem> <filename>Copyright notice</filename> fields.</para></listitem> <listitem><para>Be sure the <filename>License</filename> field is correct.</para></listitem> <listitem><para>Click <filename>Finish</filename>.</para></listitem> - <listitem><para>If the "open perspective" prompt appears, click "Yes" so that you + <listitem><para>If the "open perspective" prompt appears, click "Yes" so that you in the C/C++ perspective.</para></listitem> <listitem><para>The left-hand navigation pane shows your project. You can display your source by double clicking the project's source file. @@ -1132,36 +1132,36 @@ directory.</para></listitem> <title>Configuring the Cross-Toolchains</title> <para> - The earlier section, "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring - the Eclipse Yocto Plug-in</link>", sets up the default project - configurations. + The earlier section, "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring + the Eclipse Yocto Plug-in</link>", sets up the default project + configurations. You can override these settings for a given project by following these steps: <orderedlist> - <listitem><para>Select <filename>Project -> Change Yocto Project Settings</filename>: + <listitem><para>Select <filename>Project -> Change Yocto Project Settings</filename>: This selection brings up the <filename>Yocot Project Settings</filename> Dialog - and allows you to make changes specific to an individual project. + and allows you to make changes specific to an individual project. </para> <para>By default, the Cross Compiler Options and Target Options for a project are inherited from settings you provide using the <filename>Preferences</filename> - Dialog as described earlier - in the "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse + Dialog as described earlier + in the "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" section. The <filename>Yocto Project Settings</filename> Dialog allows you to override those default settings for a given project.</para></listitem> <listitem><para>Make your configurations for the project and click "OK". If you are running the Juno version of Eclipse, you can skip down to the next - section where you build the project. - If you are not working with Juno, you need to reconfigure the project as + section where you build the project. + If you are not working with Juno, you need to reconfigure the project as described in the next step.</para></listitem> - <listitem><para>Select <filename>Project -> Reconfigure Project</filename>: + <listitem><para>Select <filename>Project -> Reconfigure Project</filename>: This selection reconfigures the project by running - <filename>autogen.sh</filename> in the workspace for your project. + <filename>autogen.sh</filename> in the workspace for your project. The script also runs <filename>libtoolize</filename>, <filename>aclocal</filename>, - <filename>autoconf</filename>, <filename>autoheader</filename>, - <filename>automake --a</filename>, and + <filename>autoconf</filename>, <filename>autoheader</filename>, + <filename>automake --a</filename>, and <filename>./configure</filename>. - Click on the <filename>Console</filename> tab beneath your source code to + Click on the <filename>Console</filename> tab beneath your source code to see the results of reconfiguring your project.</para></listitem> </orderedlist> </para> @@ -1173,7 +1173,7 @@ directory.</para></listitem> <para> To build the project in Juno, right click on the project in the navigator pane and select <filename>Build Project</filename>. - If you are not running Juno, select <filename>Project -> Build Project</filename>. + If you are not running Juno, select <filename>Project -> Build Project</filename>. The console should update and you can note the cross-compiler you are using. </para> </section> @@ -1187,15 +1187,15 @@ directory.</para></listitem> <listitem><para>Expose the <filename>Run -> External Tools</filename> menu. Your image should appear as a selectable menu item. </para></listitem> - <listitem><para>Select your image from the menu to launch the + <listitem><para>Select your image from the menu to launch the emulator in a new window.</para></listitem> - <listitem><para>If needed, enter your host root password in the shell window at the prompt. - This sets up a <filename>Tap 0</filename> connection needed for running in user-space + <listitem><para>If needed, enter your host root password in the shell window at the prompt. + This sets up a <filename>Tap 0</filename> connection needed for running in user-space NFS mode.</para></listitem> <listitem><para>Wait for QEMU to launch.</para></listitem> - <listitem><para>Once QEMU launches, you can begin operating within that + <listitem><para>Once QEMU launches, you can begin operating within that environment. - For example, you could determine the IP Address + For example, you could determine the IP Address for the user-space NFS by using the <filename>ifconfig</filename> command. </para></listitem> </orderedlist> @@ -1206,33 +1206,33 @@ directory.</para></listitem> <title>Deploying and Debugging the Application</title> <para> - Once the QEMU emulator is running the image, using the Eclipse IDE - you can deploy your application and use the emulator to perform debugging. + Once the QEMU emulator is running the image, using the Eclipse IDE + you can deploy your application and use the emulator to perform debugging. Follow these steps to deploy the application. <orderedlist> <listitem><para>Select <filename>Run -> Debug Configurations...</filename></para></listitem> <listitem><para>In the left area, expand <filename>C/C++Remote Application</filename>.</para></listitem> - <listitem><para>Locate your project and select it to bring up a new + <listitem><para>Locate your project and select it to bring up a new tabbed view in the <filename>Debug Configurations</filename> Dialog.</para></listitem> - <listitem><para>Enter the absolute path into which you want to deploy - the application. - Use the <filename>Remote Absolute File Path for C/C++Application:</filename> field. + <listitem><para>Enter the absolute path into which you want to deploy + the application. + Use the <filename>Remote Absolute File Path for C/C++Application:</filename> field. For example, enter <filename>/usr/bin/<programname></filename>.</para></listitem> - <listitem><para>Click on the <filename>Debugger</filename> tab to see the cross-tool debugger + <listitem><para>Click on the <filename>Debugger</filename> tab to see the cross-tool debugger you are using.</para></listitem> <listitem><para>Click on the <filename>Main</filename> tab.</para></listitem> - <listitem><para>Create a new connection to the QEMU instance + <listitem><para>Create a new connection to the QEMU instance by clicking on <filename>new</filename>.</para></listitem> - <listitem><para>Select <filename>TCF</filename>, which means Target Communication + <listitem><para>Select <filename>TCF</filename>, which means Target Communication Framework.</para></listitem> <listitem><para>Click <filename>Next</filename>.</para></listitem> - <listitem><para>Clear out the <filename>host name</filename> field and enter the IP Address + <listitem><para>Clear out the <filename>host name</filename> field and enter the IP Address determined earlier.</para></listitem> - <listitem><para>Click <filename>Finish</filename> to close the + <listitem><para>Click <filename>Finish</filename> to close the <filename>New Connections</filename> Dialog.</para></listitem> - <listitem><para>Use the drop-down menu now in the <filename>Connection</filename> field and pick + <listitem><para>Use the drop-down menu now in the <filename>Connection</filename> field and pick the IP Address you entered.</para></listitem> - <listitem><para>Click <filename>Run</filename> to bring up a login screen + <listitem><para>Click <filename>Run</filename> to bring up a login screen and login.</para></listitem> <listitem><para>Accept the debug perspective.</para></listitem> </orderedlist> @@ -1243,106 +1243,106 @@ directory.</para></listitem> <title>Running User-Space Tools</title> <para> - As mentioned earlier in the manual, several tools exist that enhance - your development experience. - These tools are aids in developing and debugging applications and images. - You can run these user-space tools from within the Eclipse IDE through the + As mentioned earlier in the manual, several tools exist that enhance + your development experience. + These tools are aids in developing and debugging applications and images. + You can run these user-space tools from within the Eclipse IDE through the <filename>YoctoTools</filename> menu. </para> <para> - Once you pick a tool, you need to configure it for the remote target. - Every tool needs to have the connection configured. - You must select an existing TCF-based RSE connection to the remote target. + Once you pick a tool, you need to configure it for the remote target. + Every tool needs to have the connection configured. + You must select an existing TCF-based RSE connection to the remote target. If one does not exist, click <filename>New</filename> to create one. </para> <para> Here are some specifics about the remote tools: <itemizedlist> - <listitem><para><emphasis><filename>OProfile</filename>:</emphasis> Selecting this tool causes - the <filename>oprofile-server</filename> on the remote target to launch on - the local host machine. - The <filename>oprofile-viewer</filename> must be installed on the local host machine and the - <filename>oprofile-server</filename> must be installed on the remote target, + <listitem><para><emphasis><filename>OProfile</filename>:</emphasis> Selecting this tool causes + the <filename>oprofile-server</filename> on the remote target to launch on + the local host machine. + The <filename>oprofile-viewer</filename> must be installed on the local host machine and the + <filename>oprofile-server</filename> must be installed on the remote target, respectively, in order to use. - You must compile and install the <filename>oprofile-viewer</filename> from the source code + You must compile and install the <filename>oprofile-viewer</filename> from the source code on your local host machine. - Furthermore, in order to convert the target's sample format data into a form that the - host can use, you must have <filename>oprofile</filename> version 0.9.4 or + Furthermore, in order to convert the target's sample format data into a form that the + host can use, you must have <filename>oprofile</filename> version 0.9.4 or greater installed on the host.</para> - <para>You can locate both the viewer and server from + <para>You can locate both the viewer and server from <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>. - <note>The <filename>oprofile-server</filename> is installed by default on + <note>The <filename>oprofile-server</filename> is installed by default on the <filename>core-image-sato-sdk</filename> image.</note></para></listitem> - <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis> - Selecting this tool transfers the remote target's + <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis> + Selecting this tool transfers the remote target's <filename>Lttng</filename> tracing data back to the local host machine - and uses the <filename>Lttng</filename> Eclipse plug-in to graphically - display the output. - For information on how to use <filename>Lttng</filename> to trace an application, + and uses the <filename>Lttng</filename> Eclipse plug-in to graphically + display the output. + For information on how to use <filename>Lttng</filename> to trace an application, see <ulink url='http://lttng.org/documentation'></ulink>. <note>Do not use <filename>Lttng-user space (legacy)</filename> tool. This tool no longer has any upstream support.</note> </para> - <para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool, - you need to setup the <filename>Lttng</filename> Eclipse plug-in and create a + <para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool, + you need to setup the <filename>Lttng</filename> Eclipse plug-in and create a <filename>Tracing</filename> project. Do the following: <orderedlist> <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename> and then select <filename>Tracing</filename>.</para></listitem> - <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective + <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective into the <filename>Tracing</filename> perspective.</para></listitem> - <listitem><para>Create a new <filename>Tracing</filename> project by selecting + <listitem><para>Create a new <filename>Tracing</filename> project by selecting <filename>File -> New -> Project</filename>.</para></listitem> <listitem><para>Choose <filename>Tracing -> Tracing Project</filename>. </para></listitem> <listitem><para>Generate your tracing data on the remote target. </para></listitem> - <listitem><para>Click + <listitem><para>Click <filename>Yocto Project Tools -> Lttng2.0 ust trace import</filename> to start the data import process.</para></listitem> <listitem><para>Specify your remote connection name.</para></listitem> - <listitem><para>For the Ust directory path, specify the location of + <listitem><para>For the Ust directory path, specify the location of your remote tracing data. - Make sure the location ends with <filename>ust</filename> (e.g. + Make sure the location ends with <filename>ust</filename> (e.g. <filename>/usr/mysession/ust</filename>.</para></listitem> <listitem><para>Click <filename>OK</filename> to complete the import process. The data is now in the local tracing project you created.</para></listitem> - <listitem><para>Right click on the data and then use the menu to - <filename>Select Trace Type... -> Common Trace Format -> Generic CTF Trace</filename> + <listitem><para>Right click on the data and then use the menu to + <filename>Select Trace Type... -> Common Trace Format -> Generic CTF Trace</filename> to map the tracing type.</para></listitem> <listitem><para>Right click the mouse and select <filename>Open</filename> - to bring up the Eclipse <filename>Lttng</filename> Trace Viewer so you + to bring up the Eclipse <filename>Lttng</filename> Trace Viewer so you view the tracing data.</para></listitem> </orderedlist></para></listitem> - <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs - <filename>powertop</filename> on the remote target machine and displays the results in a + <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs + <filename>powertop</filename> on the remote target machine and displays the results in a new view called <filename>powertop</filename>.</para> - <para><filename>Time to gather data(sec):</filename> is the time passed in seconds before data + <para><filename>Time to gather data(sec):</filename> is the time passed in seconds before data is gathered from the remote target for analysis.</para> - <para><filename>show pids in wakeups list:</filename> corresponds to the - <filename>-p</filename> argument + <para><filename>show pids in wakeups list:</filename> corresponds to the + <filename>-p</filename> argument passed to <filename>powertop</filename>.</para></listitem> - <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis> - <filename>latencytop</filename> identifies system latency, while - <filename>perf</filename> monitors the system's - performance counter registers. - Selecting either of these tools causes an RSE terminal view to appear - from which you can run the tools. + <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis> + <filename>latencytop</filename> identifies system latency, while + <filename>perf</filename> monitors the system's + performance counter registers. + Selecting either of these tools causes an RSE terminal view to appear + from which you can run the tools. Both tools refresh the entire screen to display results while they run.</para></listitem> </itemizedlist> </para> - </section> + </section> <section id='customizing-an-image-using-a-bitbake-commander-project-and-hob'> <title>Customizing an Image Using a BitBake Commander Project and Hob</title> <para> - Within Eclipse, you can create a Yocto BitBake Commander project, - edit the metadata, and then use the - <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> to build a customized + Within Eclipse, you can create a Yocto BitBake Commander project, + edit the metadata, and then use the + <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> to build a customized image all within one IDE. </para> @@ -1354,17 +1354,17 @@ directory.</para></listitem> <orderedlist> <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename> and then choose <filename>Bitbake Commander</filename>.</para></listitem> - <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective into the + <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective into the Bitbake Commander perspective.</para></listitem> - <listitem><para>Select <filename>File -> New -> Project</filename> to create a new Yocto + <listitem><para>Select <filename>File -> New -> Project</filename> to create a new Yocto Bitbake Commander project.</para></listitem> <listitem><para>Choose <filename>Yocto Project Bitbake Commander -> New Yocto Project</filename> and click <filename>Next</filename>.</para></listitem> - <listitem><para>Enter the Project Name and choose the Project Location. - The Yocto project's metadata files will be put under the directory - <filename><project_location>/<project_name></filename>. - If that directory does not exist, you need to check - the "Clone from Yocto Git Repository" box, which would execute a + <listitem><para>Enter the Project Name and choose the Project Location. + The Yocto project's metadata files will be put under the directory + <filename><project_location>/<project_name></filename>. + If that directory does not exist, you need to check + the "Clone from Yocto Git Repository" box, which would execute a <filename>git clone</filename> command to get the project's metadata files. </para></listitem> <listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem> @@ -1379,7 +1379,7 @@ directory.</para></listitem> After you create the Yocto Bitbake Commander project, you can modify the metadata files by opening them in the project. When editing recipe files (<filename>.bb</filename> files), you can view BitBake - variable values and information by hovering the mouse pointer over the variable name and + variable values and information by hovering the mouse pointer over the variable name and waiting a few seconds. </para> @@ -1390,13 +1390,13 @@ directory.</para></listitem> <listitem><para>Select <filename>File -> New -> Yocto BitBake Commander -> BitBake Recipe</filename> to open a new recipe wizard.</para></listitem> <listitem><para>Point to your source by filling in the "SRC_URL" field. - For example, you can add a recipe to your + For example, you can add a recipe to your <link linkend='source-directory'>Source Directory</link> by defining "SRC_URL" as follows: <literallayout class='monospaced'> ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz </literallayout></para></listitem> - <listitem><para>Click "Populate" to calculate the archive md5, sha256, + <listitem><para>Click "Populate" to calculate the archive md5, sha256, license checksum values and to auto-generate the recipe filename.</para></listitem> <listitem><para>Fill in the "Description" field.</para></listitem> <listitem><para>Be sure values for all required fields exist.</para></listitem> @@ -1415,9 +1415,9 @@ directory.</para></listitem> <listitem><para>Select <filename>Project -> Launch HOB</filename>.</para></listitem> <listitem><para>Enter the Build Directory where you want to put your final images.</para></listitem> <listitem><para>Click <filename>OK</filename> to launch Hob.</para></listitem> - <listitem><para>Use Hob to customize and build your own images. - For information on Hob, see the - <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob Project Page</ulink> on the + <listitem><para>Use Hob to customize and build your own images. + For information on Hob, see the + <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob Project Page</ulink> on the Yocto Project website.</para></listitem> </orderedlist> </para> @@ -1429,44 +1429,44 @@ directory.</para></listitem> <title>Workflow Using Stand-alone Cross-development Toolchains</title> <para> - If you want to develop an application without prior installation of the ADT, you + If you want to develop an application without prior installation of the ADT, you still can employ the cross-development toolchain, the QEMU emulator, and a number of supported - target image files. + target image files. You just need to follow these general steps: <orderedlist> - <listitem><para><emphasis>Install the cross-development toolchain for your target hardware:</emphasis> + <listitem><para><emphasis>Install the cross-development toolchain for your target hardware:</emphasis> For information on how to install the toolchain, see the - "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" + "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" section in the Yocto Project Application Developer's Guide.</para></listitem> <listitem><para><emphasis>Download the Target Image:</emphasis> The Yocto Project supports - several target architectures and has many pre-built kernel images and root filesystem + several target architectures and has many pre-built kernel images and root filesystem images.</para> - <para>If you are going to develop your application on hardware, go to the - <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink> + <para>If you are going to develop your application on hardware, go to the + <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink> download area and choose a target machine area from which to download the kernel image and root filesystem. - This download area could have several files in it that support development using - actual hardware. - For example, the area might contain <filename>.hddimg</filename> files that combine the + This download area could have several files in it that support development using + actual hardware. + For example, the area might contain <filename>.hddimg</filename> files that combine the kernel image with the filesystem, boot loaders, etc. Be sure to get the files you need for your particular development process.</para> <para>If you are going to develop your application and then run and test it using the QEMU - emulator, go to the - <ulink url='&YOCTO_QEMU_DL_URL;'><filename>machines/qemu</filename></ulink> + emulator, go to the + <ulink url='&YOCTO_QEMU_DL_URL;'><filename>machines/qemu</filename></ulink> download area. From this area, go down into the directory for your target architecture - (e.g. <filename>qemux86_64</filename> for an + (e.g. <filename>qemux86_64</filename> for an <trademark class='registered'>Intel</trademark>-based 64-bit architecture). Download kernel, root filesystem, and any other files you need for your process. <note>In order to use the root filesystem in QEMU, you need to extract it. - See the - "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" + See the + "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" section for information on how to extract the root filesystem.</note></para></listitem> - <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point, - you have the tools to develop your application. - If you need to separately install and use the QEMU emulator, you can go to - <ulink url='http://www.qemu.org'>QEMU Home Page</ulink> to download and learn about the + <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point, + you have the tools to develop your application. + If you need to separately install and use the QEMU emulator, you can go to + <ulink url='http://www.qemu.org'>QEMU Home Page</ulink> to download and learn about the emulator.</para></listitem> </orderedlist> </para> @@ -1482,14 +1482,14 @@ directory.</para></listitem> to build packages. For example, suppose you are developing a patch and you need to experiment a bit to figure out your solution. - After you have initially built the package, you can iteratively tweak the - source code, which is located in the - <link linkend='build-directory'>Build Directory</link>, and then + After you have initially built the package, you can iteratively tweak the + source code, which is located in the + <link linkend='build-directory'>Build Directory</link>, and then you can force a re-compile and quickly test your altered code. - Once you settle on a solution, you can then preserve your changes in the form of + Once you settle on a solution, you can then preserve your changes in the form of patches. - You can accomplish these steps all within either a - <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> or + You can accomplish these steps all within either a + <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> or <link linkend='git'>Git</link> workflow. </para> @@ -1497,18 +1497,18 @@ directory.</para></listitem> <title>Finding the Temporary Source Code</title> <para> - During a build, the unpacked temporary source code used by recipes - to build packages is available in the Build Directory as - defined by the + During a build, the unpacked temporary source code used by recipes + to build packages is available in the Build Directory as + defined by the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'>S</ulink></filename> variable. - Below is the default value for the <filename>S</filename> variable as defined in the - <filename>meta/conf/bitbake.conf</filename> configuration file in the + Below is the default value for the <filename>S</filename> variable as defined in the + <filename>meta/conf/bitbake.conf</filename> configuration file in the <link linkend='source-directory'>Source Directory</link>: <literallayout class='monospaced'> S = ${WORKDIR}/${BP} </literallayout> You should be aware that many recipes override the <filename>S</filename> variable. - For example, recipes that fetch their source from Git usually set + For example, recipes that fetch their source from Git usually set <filename>S</filename> to <filename>${WORKDIR}/git</filename>. <note> The @@ -1517,11 +1517,11 @@ directory.</para></listitem> <literallayout class='monospaced'> BP = ${BPN}-${PV} </literallayout> - </note> + </note> </para> <para> - The path to the work directory for the recipe + The path to the work directory for the recipe (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends on the recipe name and the architecture of the target device. For example, here is the work directory for recipes and resulting packages that are @@ -1532,8 +1532,8 @@ directory.</para></listitem> Let's look at an example without variables. Assuming a top-level <link linkend='source-directory'>Source Directory</link> named <filename>poky</filename> - and a default Build Directory of <filename>poky/build</filename>, - the following is the work directory for the <filename>acl</filename> recipe that + and a default Build Directory of <filename>poky/build</filename>, + the following is the work directory for the <filename>acl</filename> recipe that creates the <filename>acl</filename> package: <literallayout class='monospaced'> ~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3 @@ -1541,15 +1541,15 @@ directory.</para></listitem> </para> <para> - If your resulting package is dependent on the target device, + If your resulting package is dependent on the target device, the work directory varies slightly: <literallayout class='monospaced'> ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} </literallayout> Again, assuming top-level Source Directory named <filename>poky</filename> - and a default Build Directory of <filename>poky/build</filename>, the + and a default Build Directory of <filename>poky/build</filename>, the following are the work and temporary source directories, respectively, - for the <filename>acl</filename> package that is being + for the <filename>acl</filename> package that is being built for a MIPS-based device: <literallayout class='monospaced'> ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2 @@ -1558,7 +1558,7 @@ directory.</para></listitem> </para> <note> - To better understand how the OpenEmbedded build system resolves directories during the + To better understand how the OpenEmbedded build system resolves directories during the build process, see the glossary entries for the <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>, @@ -1573,20 +1573,20 @@ directory.</para></listitem> </note> <para> - Now that you know where to locate the directory that has the temporary source code, - you can use a Quilt or Git workflow to make your edits, test the changes, + Now that you know where to locate the directory that has the temporary source code, + you can use a Quilt or Git workflow to make your edits, test the changes, and preserve the changes in the form of patches. </para> </section> <section id="using-a-quilt-workflow"> <title>Using a Quilt Workflow</title> - + <para> <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink> - is a powerful tool that allows you to capture source code changes without having + is a powerful tool that allows you to capture source code changes without having a clean source tree. - This section outlines the typical workflow you can use to modify temporary source code, + This section outlines the typical workflow you can use to modify temporary source code, test changes, and then preserve the changes in the form of a patch all using Quilt. </para> @@ -1594,15 +1594,15 @@ directory.</para></listitem> Follow these general steps: <orderedlist> <listitem><para><emphasis>Find the Source Code:</emphasis> - The temporary source code used by the OpenEmbedded build system is kept in the - Build Directory. - See the + The temporary source code used by the OpenEmbedded build system is kept in the + Build Directory. + See the "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" - section to learn how to locate the directory that has the temporary source code for a + section to learn how to locate the directory that has the temporary source code for a particular package.</para></listitem> <listitem><para><emphasis>Change Your Working Directory:</emphasis> You need to be in the directory that has the temporary source code. - That directory is defined by the + That directory is defined by the <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> variable.</para></listitem> <listitem><para><emphasis>Create a New Patch:</emphasis> @@ -1612,7 +1612,7 @@ directory.</para></listitem> $ quilt new my_changes.patch </literallayout></para></listitem> <listitem><para><emphasis>Notify Quilt and Add Files:</emphasis> - After creating the patch, you need to notify Quilt about the files + After creating the patch, you need to notify Quilt about the files you plan to edit. You notify Quilt by adding the files to the patch you just created: <literallayout class='monospaced'> @@ -1623,50 +1623,50 @@ directory.</para></listitem> Make your changes in the temporary source code to the files you added to the patch.</para></listitem> <listitem><para><emphasis>Test Your Changes:</emphasis> - Once you have modified the source code, the easiest way to test your changes + Once you have modified the source code, the easiest way to test your changes is by calling the <filename>compile</filename> task as shown in the following example: <literallayout class='monospaced'> $ bitbake -c compile -f <name_of_package> </literallayout> The <filename>-f</filename> or <filename>--force</filename> option forces re-execution of the specified task. - If you find problems with your code, you can just keep editing and + If you find problems with your code, you can just keep editing and re-testing iteratively until things work as expected. <note>All the modifications you make to the temporary source code - disappear once you <filename>-c clean</filename> or + disappear once you <filename>-c clean</filename> or <filename>-c cleanall</filename> with BitBake for the package. Modifications will also disappear if you use the <filename>rm_work</filename> feature as described in the - "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start. </note></para></listitem> <listitem><para><emphasis>Generate the Patch:</emphasis> - Once your changes work as expected, you need to use Quilt to generate the final patch that + Once your changes work as expected, you need to use Quilt to generate the final patch that contains all your modifications. <literallayout class='monospaced'> $ quilt refresh </literallayout> - At this point the <filename>my_changes.patch</filename> file has all your edits made - to the <filename>file1.c</filename>, <filename>file2.c</filename>, and + At this point the <filename>my_changes.patch</filename> file has all your edits made + to the <filename>file1.c</filename>, <filename>file2.c</filename>, and <filename>file3.c</filename> files.</para> - <para>You can find the resulting patch file in the <filename>patches/</filename> + <para>You can find the resulting patch file in the <filename>patches/</filename> subdirectory of the source (<filename>S</filename>) directory.</para></listitem> - <listitem><para><emphasis>Copy the Patch File:</emphasis> + <listitem><para><emphasis>Copy the Patch File:</emphasis> For simplicity, copy the patch file into a directory named <filename>files</filename>, - which you can create in the same directory that holds the recipe - (<filename>.bb</filename>) file or the + which you can create in the same directory that holds the recipe + (<filename>.bb</filename>) file or the append (<filename>.bbappend</filename>) file. Placing the patch here guarantees that the OpenEmbedded build system will find the patch. - Next, add the patch into the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> - of the recipe. + Next, add the patch into the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> + of the recipe. Here is an example: <literallayout class='monospaced'> SRC_URI += "file://my_changes.patch" </literallayout></para></listitem> <listitem><para><emphasis>Increment the Recipe Revision Number:</emphasis> - Finally, don't forget to 'bump' the + Finally, don't forget to 'bump' the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> value in the recipe since the resulting packages have changed.</para></listitem> </orderedlist> @@ -1675,16 +1675,16 @@ directory.</para></listitem> <section id='using-a-git-workflow'> <title>Using a Git Workflow</title> <para> - Git is an even more powerful tool that allows you to capture source code changes without having + Git is an even more powerful tool that allows you to capture source code changes without having a clean source tree. - This section outlines the typical workflow you can use to modify temporary source code, + This section outlines the typical workflow you can use to modify temporary source code, test changes, and then preserve the changes in the form of a patch all using Git. - For general information on Git as it is used in the Yocto Project, see the + For general information on Git as it is used in the Yocto Project, see the "<link linkend='git'>Git</link>" section. </para> <note> - This workflow uses Git only for its ability to manage local changes to the source code + This workflow uses Git only for its ability to manage local changes to the source code and produce patches independent of any version control system used with the Yocto Project. </note> @@ -1692,53 +1692,53 @@ directory.</para></listitem> Follow these general steps: <orderedlist> <listitem><para><emphasis>Find the Source Code:</emphasis> - The temporary source code used by the OpenEmbedded build system is kept in the - Build Directory. - See the + The temporary source code used by the OpenEmbedded build system is kept in the + Build Directory. + See the "<link linkend='finding-the-temporary-source-code'>Finding the Temporary Source Code</link>" - section to learn how to locate the directory that has the temporary source code for a + section to learn how to locate the directory that has the temporary source code for a particular package.</para></listitem> <listitem><para><emphasis>Change Your Working Directory:</emphasis> You need to be in the directory that has the temporary source code. - That directory is defined by the + That directory is defined by the <ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink> variable.</para></listitem> <listitem><para><emphasis>If needed, initialize a Git Repository:</emphasis> - If the recipe you are working with does not use a Git fetcher, + If the recipe you are working with does not use a Git fetcher, you need to set up a Git repository as follows: <literallayout class='monospaced'> $ git init $ git add * $ git commit -m "initial revision" </literallayout> - The above Git commands initialize a Git repository that is based on the + The above Git commands initialize a Git repository that is based on the files in your current working directory, stage all the files, and commit - the files. + the files. At this point, your Git repository is aware of all the source code files. - Any edits you now make to files can be committed later and will be tracked by + Any edits you now make to files can be committed later and will be tracked by Git.</para></listitem> <listitem><para><emphasis>Edit the Files:</emphasis> Make your changes to the temporary source code.</para></listitem> <listitem><para><emphasis>Test Your Changes:</emphasis> - Once you have modified the source code, the easiest way to test your changes + Once you have modified the source code, the easiest way to test your changes is by calling the <filename>compile</filename> task as shown in the following example: <literallayout class='monospaced'> $ bitbake -c compile -f <name_of_package> </literallayout> The <filename>-f</filename> or <filename>--force</filename> option forces re-execution of the specified task. - If you find problems with your code, you can just keep editing and + If you find problems with your code, you can just keep editing and re-testing iteratively until things work as expected. <note>All the modifications you make to the temporary source code disappear once you <filename>-c clean</filename>, <filename>-c cleansstate</filename>, or <filename>-c cleanall</filename> with BitBake for the package. Modifications will also disappear if you use the <filename>rm_work</filename> feature as described in the - "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section of the Yocto Project Quick Start. </note></para></listitem> <listitem><para><emphasis>See the List of Files You Changed:</emphasis> - Use the <filename>git status</filename> command to see what files you have actually edited. + Use the <filename>git status</filename> command to see what files you have actually edited. The ability to have Git track the files you have changed is an advantage that this workflow has over the Quilt workflow. Here is the Git command to list your changed files: @@ -1752,15 +1752,15 @@ directory.</para></listitem> $ git add file1.c file2.c file3.c </literallayout></para></listitem> <listitem><para><emphasis>Commit the Staged Files and View Your Changes:</emphasis> - Use the <filename>git commit</filename> command to commit the changes to the - local repository. + Use the <filename>git commit</filename> command to commit the changes to the + local repository. Once you have committed the files, you can use the <filename>git log</filename> command to see your changes: <literallayout class='monospaced'> $ git commit -m "<commit-summary-message>" $ git log </literallayout> - <note>The name of the patch file created in the next step is based on your + <note>The name of the patch file created in the next step is based on your <filename>commit-summary-message</filename>.</note></para></listitem> <listitem><para><emphasis>Generate the Patch:</emphasis> Once the changes are committed, use the <filename>git format-patch</filename> @@ -1768,30 +1768,30 @@ directory.</para></listitem> <literallayout class='monospaced'> $ git format-patch -1 </literallayout> - Specifying "-1" causes Git to generate the + Specifying "-1" causes Git to generate the patch file for the most recent commit.</para> - <para>At this point, the patch file has all your edits made - to the <filename>file1.c</filename>, <filename>file2.c</filename>, and + <para>At this point, the patch file has all your edits made + to the <filename>file1.c</filename>, <filename>file2.c</filename>, and <filename>file3.c</filename> files. - You can find the resulting patch file in the current directory and it + You can find the resulting patch file in the current directory and it is named according to the <filename>git commit</filename> summary line. The patch file ends with <filename>.patch</filename>.</para></listitem> - <listitem><para><emphasis>Copy the Patch File:</emphasis> + <listitem><para><emphasis>Copy the Patch File:</emphasis> For simplicity, copy the patch file into a directory named <filename>files</filename>, - which you can create in the same directory that holds the recipe - (<filename>.bb</filename>) file or the + which you can create in the same directory that holds the recipe + (<filename>.bb</filename>) file or the append (<filename>.bbappend</filename>) file. Placing the patch here guarantees that the OpenEmbedded build system will find the patch. - Next, add the patch into the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> - of the recipe. + Next, add the patch into the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'>SRC_URI</ulink></filename> + of the recipe. Here is an example: <literallayout class='monospaced'> SRC_URI += "file://0001-<commit-summary-message>.patch" </literallayout></para></listitem> <listitem><para><emphasis>Increment the Recipe Revision Number:</emphasis> - Finally, don't forget to 'bump' the + Finally, don't forget to 'bump' the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'>PR</ulink></filename> value in the recipe since the resulting packages have changed.</para></listitem> </orderedlist> @@ -1803,7 +1803,7 @@ directory.</para></listitem> <title>Image Development Using Hob</title> <para> - The <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> is a graphical user interface for the + The <ulink url='&YOCTO_HOME_URL;/projects/hob'>Hob</ulink> is a graphical user interface for the OpenEmbedded build system, which is based on BitBake. You can use the Hob to build custom operating system images within the Yocto Project build environment. Hob simply provides a friendly interface over the build system used during system development. @@ -1821,13 +1821,13 @@ directory.</para></listitem> $ source oe-init-build-env $ hob </literallayout></para></listitem> - <listitem><para>You can set the + <listitem><para>You can set the <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> for which you are building the image.</para></listitem> - <listitem><para>You can modify various policy settings such as the package format used to build with, - the parrallelism BitBake uses, whether or not to build an external toolchain, and which host + <listitem><para>You can modify various policy settings such as the package format used to build with, + the parrallelism BitBake uses, whether or not to build an external toolchain, and which host to build against.</para></listitem> - <listitem><para>You can manage + <listitem><para>You can manage <link linkend='understanding-and-creating-layers'>layers</link>.</para></listitem> <listitem><para>You can select a base image and then add extra packages for your custom build. </para></listitem> @@ -1840,16 +1840,16 @@ directory.</para></listitem> <title>Using a Development Shell</title> <para> - When debugging certain commands or even when just editing packages, + When debugging certain commands or even when just editing packages, <filename>devshell</filename> can be a useful tool. - When you invoke <filename>devshell</filename>, source files are - extracted into your working directory and patches are applied. + When you invoke <filename>devshell</filename>, source files are + extracted into your working directory and patches are applied. Then, a new terminal is opened and you are placed in the working directory. - In the new terminal, all the OpenEmbedded build-related environment variables are - still defined so you can use commands such as <filename>configure</filename> and - <filename>make</filename>. - The commands execute just as if the OpenEmbedded build system were executing them. - Consequently, working this way can be helpful when debugging a build or preparing + In the new terminal, all the OpenEmbedded build-related environment variables are + still defined so you can use commands such as <filename>configure</filename> and + <filename>make</filename>. + The commands execute just as if the OpenEmbedded build system were executing them. + Consequently, working this way can be helpful when debugging a build or preparing software to be used with the OpenEmbedded build system. </para> @@ -1862,46 +1862,46 @@ directory.</para></listitem> </para> <para> - This command spawns a terminal with a shell prompt within the OpenEmbedded build environment. + This command spawns a terminal with a shell prompt within the OpenEmbedded build environment. The <ulink url='&YOCTO_DOCS_REF_URL;#var-OE_TERMINAL'><filename>OE_TERMINAL</filename></ulink> controls what type of shell is opened. </para> - + <para> For spawned terminals, the following occurs: <itemizedlist> - <listitem><para>The <filename>PATH</filename> variable includes the + <listitem><para>The <filename>PATH</filename> variable includes the cross-toolchain.</para></listitem> - <listitem><para>The <filename>pkgconfig</filename> variables find the correct + <listitem><para>The <filename>pkgconfig</filename> variables find the correct <filename>.pc</filename> files.</para></listitem> - <listitem><para>The <filename>configure</filename> command finds the + <listitem><para>The <filename>configure</filename> command finds the Yocto Project site files as well as any other necessary files.</para></listitem> </itemizedlist> </para> <para> Within this environment, you can run configure or compile - commands as if they were being run by + commands as if they were being run by the OpenEmbedded build system itself. - As noted earlier, the working directory also automatically changes to the + As noted earlier, the working directory also automatically changes to the Source Directory (<ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>). </para> - <para> + <para> When you are finished, you just exit the shell or close the terminal window. </para> <note> <para> It is worth remembering that when using <filename>devshell</filename> - you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename> + you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename> instead of just using <filename>gcc</filename>. - The same applies to other applications such as <filename>binutils</filename>, + The same applies to other applications such as <filename>binutils</filename>, <filename>libtool</filename> and so forth. BitBake sets up environment variables such as <filename>CC</filename> to assist applications, such as <filename>make</filename> to find the correct tools. </para> - + <para> It is also worth noting that <filename>devshell</filename> still works over X11 forwarding and similar situations diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 0e1041b4b8..e09c373da2 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -8,11 +8,11 @@ <para> This chapter helps you understand the Yocto Project as an open source development project. - In general, working in an open source environment is very different from working in a - closed, proprietary environment. - Additionally, the Yocto Project uses specific tools and constructs as part of its development - environment. - This chapter specifically addresses open source philosophy, licensing issues, code repositories, + In general, working in an open source environment is very different from working in a + closed, proprietary environment. + Additionally, the Yocto Project uses specific tools and constructs as part of its development + environment. + This chapter specifically addresses open source philosophy, licensing issues, code repositories, the open source distributed version control system Git, and best practices using the Yocto Project. </para> @@ -20,36 +20,36 @@ <title>Open Source Philosophy</title> <para> - Open source philosophy is characterized by software development directed by peer production + Open source philosophy is characterized by software development directed by peer production and collaboration through an active community of developers. - Contrast this to the more standard centralized development models used by commercial software + Contrast this to the more standard centralized development models used by commercial software companies where a finite set of developers produces a product for sale using a defined set of procedures that ultimately result in an end product whose architecture and source material are closed to the public. </para> <para> - Open source projects conceptually have differing concurrent agendas, approaches, and production. - These facets of the development process can come from anyone in the public (community) that has a - stake in the software project. - The open source environment contains new copyright, licensing, domain, and consumer issues - that differ from the more traditional development environment. + Open source projects conceptually have differing concurrent agendas, approaches, and production. + These facets of the development process can come from anyone in the public (community) that has a + stake in the software project. + The open source environment contains new copyright, licensing, domain, and consumer issues + that differ from the more traditional development environment. In an open source environment, the end product, source material, and documentation are all available to the public at no cost. </para> <para> - A benchmark example of an open source project is the Linux Kernel, which was initially conceived - and created by Finnish computer science student Linus Torvalds in 1991. - Conversely, a good example of a non-open source project is the - <trademark class='registered'>Windows</trademark> family of operating + A benchmark example of an open source project is the Linux Kernel, which was initially conceived + and created by Finnish computer science student Linus Torvalds in 1991. + Conversely, a good example of a non-open source project is the + <trademark class='registered'>Windows</trademark> family of operating systems developed by <trademark class='registered'>Microsoft</trademark> Corporation. </para> <para> - Wikipedia has a good historical description of the Open Source Philosophy - <ulink url='http://en.wikipedia.org/wiki/Open_source'>here</ulink>. - You can also find helpful information on how to participate in the Linux Community + Wikipedia has a good historical description of the Open Source Philosophy + <ulink url='http://en.wikipedia.org/wiki/Open_source'>here</ulink>. + You can also find helpful information on how to participate in the Linux Community <ulink url='http://ldn.linuxfoundation.org/book/how-participate-linux-community'>here</ulink>. </para> </section> @@ -58,72 +58,72 @@ <title>Using the Yocto Project in a Team Environment</title> <para> - It might not be immediately clear how you can use the Yocto Project in a team environment, - or scale it for a large team of developers. + It might not be immediately clear how you can use the Yocto Project in a team environment, + or scale it for a large team of developers. The specifics of any situation determine the best solution. - Granted that the Yocto Project offers immense flexibility regarding this, practices do exist + Granted that the Yocto Project offers immense flexibility regarding this, practices do exist that experience has shown work well. </para> <para> - The core component of any development effort with the Yocto Project is often an - automated build and testing framework along with an image generation process. - You can use these core components to check that the metadata can be built, - highlight when commits break the build, and provide up-to-date images that - allow developers to test the end result and use it as a base platform for further - development. - Experience shows that buildbot is a good fit for this role. + The core component of any development effort with the Yocto Project is often an + automated build and testing framework along with an image generation process. + You can use these core components to check that the metadata can be built, + highlight when commits break the build, and provide up-to-date images that + allow developers to test the end result and use it as a base platform for further + development. + Experience shows that buildbot is a good fit for this role. What works well is to configure buildbot to make two types of builds: - incremental and full (from scratch). - See "<ulink url='http://autobuilder.yoctoproject.org:8010/'>Welcome to the buildbot for the Yocto Project</ulink>" + incremental and full (from scratch). + See "<ulink url='http://autobuilder.yoctoproject.org:8010/'>Welcome to the buildbot for the Yocto Project</ulink>" for an example implementation that uses buildbot. </para> <para> You can tie an incremental build to a commit hook that triggers the build - each time a commit is made to the metadata. - This practice results in useful acid tests that determine whether a given commit - breaks the build in some serious way. + each time a commit is made to the metadata. + This practice results in useful acid tests that determine whether a given commit + breaks the build in some serious way. Associating a build to a commit can catch a lot of simple errors. Furthermore, the tests are fast so developers can get quick feedback on changes. </para> <para> - Full builds build and test everything from the ground up. - These types of builds usually happen at predetermined times like during the + Full builds build and test everything from the ground up. + These types of builds usually happen at predetermined times like during the night when the machine load is low. </para> <para> - Most teams have many pieces of software undergoing active development at any given time. - You can derive large benefits by putting these pieces under the control of a source - control system that is compatible (i.e. Git or Subversion (SVN)) with the OpenEmbeded + Most teams have many pieces of software undergoing active development at any given time. + You can derive large benefits by putting these pieces under the control of a source + control system that is compatible (i.e. Git or Subversion (SVN)) with the OpenEmbeded build system that the Yocto Project uses. - You can then set the autobuilder to pull the latest revisions of the packages + You can then set the autobuilder to pull the latest revisions of the packages and test the latest commits by the builds. - This practice quickly highlights issues. - The build system easily supports testing configurations that use both a + This practice quickly highlights issues. + The build system easily supports testing configurations that use both a stable known good revision and a floating revision. The build system can also take just the changes from specific source control branches. This capability allows you to track and test specific changes. </para> <para> - Perhaps the hardest part of setting this up is defining the software project or + Perhaps the hardest part of setting this up is defining the software project or the metadata policies that surround the different source control systems. Of course circumstances will be different in each case. - However, this situation reveals one of the Yocto Project's advantages - + However, this situation reveals one of the Yocto Project's advantages - the system itself does not - force any particular policy on users, unlike a lot of build systems. + force any particular policy on users, unlike a lot of build systems. The system allows the best policies to be chosen for the given circumstances. </para> <para> In general, best practices exist that make your work with the Yocto - Project easier in a team environment. + Project easier in a team environment. This list presents some of these practices you might consider following. Of course, you need to understand that you do not have to follow these - practices and your setup can be totally controlled and customized by + practices and your setup can be totally controlled and customized by your team: <itemizedlist> <listitem><para>Use <link linkend='git'>Git</link> @@ -131,9 +131,9 @@ <listitem><para>Maintain your metadata in layers that make sense for your situation. See the "<link linkend='understanding-and-creating-layers'>Understanding - and Creating Layeres</link>" section for more information on + and Creating Layeres</link>" section for more information on layers.</para></listitem> - <listitem><para>Separate the project's metadata and code by using + <listitem><para>Separate the project's metadata and code by using separate Git repositories. See the "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>" section for information on these @@ -144,10 +144,10 @@ <listitem><para>Set up the directory for the shared state cache (<ulink url='&YOCTO_DOCS_REF_URL;#var-SSTATE_DIR'><filename>SSTATE_DIR</filename></ulink>) where they make sense. - For example, set up the sstate cache for developers using the + For example, set up the sstate cache for developers using the same office and share source directories on the developer's machines.</para></listitem> - <listitem><para>Set up an autobuilder and have it populate the + <listitem><para>Set up an autobuilder and have it populate the sstate cache and source directories.</para></listitem> </itemizedlist> </para> @@ -157,37 +157,37 @@ <title>Yocto Project Source Repositories</title> <para> - The Yocto Project team maintains complete source repositories for all Yocto Project files + The Yocto Project team maintains complete source repositories for all Yocto Project files at <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. This web-based source code browser is organized into categories by function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. - From the interface, you can click on any particular item in the "Name" column and - see the URL at the bottom of the page that you need to set up a Git repository for + From the interface, you can click on any particular item in the "Name" column and + see the URL at the bottom of the page that you need to set up a Git repository for that particular item. - Having a local Git repository of the Source Directory (poky) allows you to - make changes, contribute to the history, and ultimately enhance the Yocto Project's + Having a local Git repository of the Source Directory (poky) allows you to + make changes, contribute to the history, and ultimately enhance the Yocto Project's tools, Board Support Packages, and so forth. </para> - <para> - Conversely, if you are a developer that is not interested in contributing back to the + <para> + Conversely, if you are a developer that is not interested in contributing back to the Yocto Project, you have the ability to simply download and extract release tarballs and use them within the Yocto Project environment. - All that is required is a particular release of the Yocto Project and - your application source code. + All that is required is a particular release of the Yocto Project and + your application source code. </para> <para> - For any supported release of Yocto Project, you can go to the Yocto Project website’s - <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink> and get a - tarball of the release. + For any supported release of Yocto Project, you can go to the Yocto Project website’s + <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink> and get a + tarball of the release. You can also go to this site to download any supported BSP tarballs. - Unpacking the tarball gives you a hierarchical Source Directory that lets you develop + Unpacking the tarball gives you a hierarchical Source Directory that lets you develop using the Yocto Project. </para> <para> - Once you are set up through either tarball extraction or creation of Git repositories, + Once you are set up through either tarball extraction or creation of Git repositories, you are ready to develop. </para> @@ -195,18 +195,18 @@ In summary, here is where you can get the project files needed for development: <itemizedlist> <listitem><para id='source-repositories'><emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> - This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto + This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto Metadata Layers. You can create local copies of Git repositories for each of these areas.</para> <para> <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" /> </para></listitem> <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis> - This area contains index releases such as + This area contains index releases such as the <trademark class='trade'>Eclipse</trademark> Yocto Plug-in, miscellaneous support, poky, pseudo, installers for cross-development toolchains, and all released versions of Yocto Project in the form of images or tarballs. - Downloading and extracting these files does not produce a local copy of the + Downloading and extracting these files does not produce a local copy of the Git repository but rather a snapshot of a particular release or image.</para> <para> <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="4in" /> @@ -214,7 +214,7 @@ <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;/download'>Yocto Project Download Page</ulink></emphasis> This page on the Yocto Project website allows you to download any Yocto Project release or Board Support Package (BSP) in tarball form. - The tarballs are similar to those found in the + The tarballs are similar to those found in the <ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink> area.</para> <para> <imagedata fileref="figures/yp-download.png" align="center" width="6in" depth="4in" /> @@ -227,17 +227,17 @@ <title>Yocto Project Terms</title> <para> - Following is a list of terms and definitions users new to the Yocto Project development + Following is a list of terms and definitions users new to the Yocto Project development environment might find helpful. While some of these terms are universal, the list includes them just in case: <itemizedlist> - <listitem><para><emphasis>Append Files:</emphasis> Files that append build information to + <listitem><para><emphasis>Append Files:</emphasis> Files that append build information to a recipe file. Append files are known as BitBake append files and <filename>.bbappend</filename> files. - The OpenEmbedded build system expects every append file to have a corresponding and + The OpenEmbedded build system expects every append file to have a corresponding and underlying recipe (<filename>.bb</filename>) file. Furthermore, the append file and the underlying recipe must have the same root filename. - The filenames can differ only in the file type suffix used (e.g. + The filenames can differ only in the file type suffix used (e.g. <filename>formfactor_0.0.bb</filename> and <filename>formfactor_0.0.bbappend</filename>). </para> <para>Information in append files overrides the information in the similarly-named recipe file. @@ -245,20 +245,20 @@ "<link linkend='using-bbappend-files'>Using .bbappend Files</link>" section. </para></listitem> <listitem><para id='bitbake-term'><emphasis>BitBake:</emphasis> - The task executor and scheduler used by - the OpenEmbedded build system to build images. - For more information on BitBake, see the BitBake documentation - in the <filename>bitbake/doc/manual</filename> directory of the + The task executor and scheduler used by + the OpenEmbedded build system to build images. + For more information on BitBake, see the BitBake documentation + in the <filename>bitbake/doc/manual</filename> directory of the <link linkend='source-directory'>Source Directory</link>.</para></listitem> <listitem> <para id='build-directory'><emphasis>Build Directory:</emphasis> - This term refers to the area used by the OpenEmbedded build system for builds. - The area is created when you <filename>source</filename> the setup + This term refers to the area used by the OpenEmbedded build system for builds. + The area is created when you <filename>source</filename> the setup environment script that is found in the Source Directory (i.e. <filename>&OE_INIT_FILE;</filename>). The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> variable points to the Build Directory.</para> - + <para>You have a lot of flexibility when creating the Build Directory. Following are some examples that show how to create the directory: <itemizedlist> @@ -268,119 +268,119 @@ <literallayout class='monospaced'> $ source &OE_INIT_PATH; </literallayout></para></listitem> - <listitem><para>Provide a directory path and specifically name the build - directory. + <listitem><para>Provide a directory path and specifically name the build + directory. This next example creates a Build Directory named <filename>YP-&POKYVERSION;</filename> in your home directory within the directory <filename>mybuilds</filename>. If <filename>mybuilds</filename> does not exist, the directory is created for you: - <literallayout class='monospaced'> + <literallayout class='monospaced'> $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION; </literallayout></para></listitem> <listitem><para>Provide an existing directory to use as the Build Directory. - This example uses the existing <filename>mybuilds</filename> directory + This example uses the existing <filename>mybuilds</filename> directory as the Build Directory. - <literallayout class='monospaced'> + <literallayout class='monospaced'> $ source &OE_INIT_PATH; $HOME/mybuilds/ </literallayout></para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para><emphasis>Build System:</emphasis> In the context of the Yocto Project - this term refers to the OpenEmbedded build system used by the project. + </itemizedlist> + </para></listitem> + <listitem><para><emphasis>Build System:</emphasis> In the context of the Yocto Project + this term refers to the OpenEmbedded build system used by the project. This build system is based on the project known as "Poky." - For some historical information about Poky, see the + For some historical information about Poky, see the <link linkend='poky'>Poky</link> term further along in this section. </para></listitem> <listitem><para><emphasis>Classes:</emphasis> Files that provide for logic encapsulation - and inheritance allowing commonly used patterns to be defined once and easily used - in multiple recipes. + and inheritance allowing commonly used patterns to be defined once and easily used + in multiple recipes. Class files end with the <filename>.bbclass</filename> filename extension. </para></listitem> <listitem><para><emphasis>Configuration File:</emphasis> Configuration information in various <filename>.conf</filename> files provides global definitions of variables. - The <filename>conf/local.conf</filename> configuration file in the + The <filename>conf/local.conf</filename> configuration file in the <link linkend='build-directory'>Build Directory</link> contains user-defined variables that affect each build. The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file defines Yocto ‘distro’ configuration - variables used only when building with this policy. - Machine configuration files, which - are located throughout the + variables used only when building with this policy. + Machine configuration files, which + are located throughout the <link linkend='source-directory'>Source Directory</link>, define - variables for specific hardware and are only used when building for that target - (e.g. the <filename>machine/beagleboard.conf</filename> configuration file defines - variables for the Texas Instruments ARM Cortex-A8 development board). + variables for specific hardware and are only used when building for that target + (e.g. the <filename>machine/beagleboard.conf</filename> configuration file defines + variables for the Texas Instruments ARM Cortex-A8 development board). Configuration files end with a <filename>.conf</filename> filename extension. </para></listitem> - <listitem><para><emphasis>Cross-Development Toolchain:</emphasis> + <listitem><para><emphasis>Cross-Development Toolchain:</emphasis> A collection of software development tools and utilities that allow you to develop software for targeted architectures. - This toolchain contains cross-compilers, linkers, and debuggers that are specific to + This toolchain contains cross-compilers, linkers, and debuggers that are specific to an architecture. You can use the OpenEmbedded build system to build a cross-development toolchain - installer that when run installs the toolchain that contains the development tools you + installer that when run installs the toolchain that contains the development tools you need to cross-compile and test your software. - The Yocto Project ships with images that contain installers for + The Yocto Project ships with images that contain installers for toolchains for supported architectures as well. Sometimes this toolchain is referred to as the meta-toolchain.</para></listitem> - <listitem><para><emphasis>Image:</emphasis> An image is the result produced when + <listitem><para><emphasis>Image:</emphasis> An image is the result produced when BitBake processes a given collection of recipes and related metadata. - Images are the binary output that run on specific hardware or QEMU + Images are the binary output that run on specific hardware or QEMU and for specific use cases. For a list of the supported image types that the Yocto Project provides, see the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in the Yocto Project Reference Manual.</para></listitem> - <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, + <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, a BSP, or an application stack. - For a discussion on BSP Layers, see the + For a discussion on BSP Layers, see the "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" section in the Yocto Project Board Support Packages (BSP) Developer's Guide.</para></listitem> - <listitem><para id='metadata'><emphasis>Metadata:</emphasis> The files that BitBake parses when - building an image. + <listitem><para id='metadata'><emphasis>Metadata:</emphasis> The files that BitBake parses when + building an image. Metadata includes recipes, classes, and configuration files.</para></listitem> - <listitem><para id='oe-core'><emphasis>OE-Core:</emphasis> A core set of metadata originating + <listitem><para id='oe-core'><emphasis>OE-Core:</emphasis> A core set of metadata originating with OpenEmbedded (OE) that is shared between OE and the Yocto Project. This metadata is found in the <filename>meta</filename> directory of the source directory.</para></listitem> - <listitem><para><emphasis>Package:</emphasis> In the context of the Yocto Project, + <listitem><para><emphasis>Package:</emphasis> In the context of the Yocto Project, this term refers to the packaged output from a baked recipe. - A package is generally the compiled binaries produced from the recipe's sources. + A package is generally the compiled binaries produced from the recipe's sources. You ‘bake’ something by running it through BitBake.</para> <para>It is worth noting that the term "package" can, in general, have subtle - meanings. For example, the packages refered to in the + meanings. For example, the packages refered to in the "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are - compiled binaries that when installed add functionality to your Linux + compiled binaries that when installed add functionality to your Linux distribution.</para> <para>Another point worth noting is that historically within the Yocto Project, - recipes were referred to as packages - thus, the existence of several BitBake - variables that are seemingly mis-named, + recipes were referred to as packages - thus, the existence of several BitBake + variables that are seemingly mis-named, (e.g. <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-PRINC'><filename>PRINC</filename></ulink>, - <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and + <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, and <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink>). </para></listitem> <listitem><para id='poky'><emphasis>Poky:</emphasis> The term "poky" can mean several things. In its most general sense, it is an open-source project that was initially developed by OpenedHand. With OpenedHand, poky was developed off of the existing OpenEmbedded - build system becoming a build system for embedded images. - After Intel Corporation aquired OpenedHand, the project poky became the basis for + build system becoming a build system for embedded images. + After Intel Corporation aquired OpenedHand, the project poky became the basis for the Yocto Project's build system. Within the Yocto Project source repositories, poky exists as a separate Git repository - that can be cloned to yield a local copy on the host system. + that can be cloned to yield a local copy on the host system. Thus, "poky" can refer to the local copy of the Source Directory used to develop within the Yocto Project.</para></listitem> - <listitem><para><emphasis>Recipe:</emphasis> A set of instructions for building packages. + <listitem><para><emphasis>Recipe:</emphasis> A set of instructions for building packages. A recipe describes where you get source code and which patches to apply. - Recipes describe dependencies for libraries or for other recipes, and they - also contain configuration and compilation options. - Recipes contain the logical unit of execution, the software/images to build, and + Recipes describe dependencies for libraries or for other recipes, and they + also contain configuration and compilation options. + Recipes contain the logical unit of execution, the software/images to build, and use the <filename>.bb</filename> file extension.</para></listitem> <listitem> <para id='source-directory'><emphasis>Source Directory:</emphasis> - This term refers to the directory structure created as a result of either downloading - and unpacking a Yocto Project release tarball or creating a local copy of - the <filename>poky</filename> Git repository + This term refers to the directory structure created as a result of either downloading + and unpacking a Yocto Project release tarball or creating a local copy of + the <filename>poky</filename> Git repository <filename>git://git.yoctoproject.org/poky</filename>. - Sometimes you might here the term "poky directory" used to refer to this + Sometimes you might here the term "poky directory" used to refer to this directory structure. <note> The OpenEmbedded build system does not support file or directory names that @@ -388,55 +388,55 @@ Be sure that the Source Directory you use does not contain these types of names. </note></para> - <para>The Source Directory contains BitBake, Documentation, metadata and - other files that all support the Yocto Project. - Consequently, you must have the Source Directory in place on your development + <para>The Source Directory contains BitBake, Documentation, metadata and + other files that all support the Yocto Project. + Consequently, you must have the Source Directory in place on your development system in order to do any development using the Yocto Project.</para> - <para>For tarball expansion, the name of the top-level directory of the Source Directory + <para>For tarball expansion, the name of the top-level directory of the Source Directory is derived from the Yocto Project release tarball. For example, downloading and unpacking <filename>&YOCTO_POKY_TARBALL;</filename> - results in a Source Directory whose top-level folder is named + results in a Source Directory whose top-level folder is named <filename>&YOCTO_POKY;</filename>. - If you create a local copy of the Git repository, then you can name the repository + If you create a local copy of the Git repository, then you can name the repository anything you like. - Throughout much of the documentation, <filename>poky</filename> is used as the name of + Throughout much of the documentation, <filename>poky</filename> is used as the name of the top-level folder of the local copy of the poky Git repository. - So, for example, cloning the <filename>poky</filename> Git repository results in a + So, for example, cloning the <filename>poky</filename> Git repository results in a local Git repository whose top-level folder is also named <filename>poky</filename>.</para> <para>It is important to understand the differences between the Source Directory created - by unpacking a released tarball as compared to cloning + by unpacking a released tarball as compared to cloning <filename>git://git.yoctoproject.org/poky</filename>. - When you unpack a tarball, you have an exact copy of the files based on the time of + When you unpack a tarball, you have an exact copy of the files based on the time of release - a fixed release point. Any changes you make to your local files in the Source Directory are on top of the release. On the other hand, when you clone the <filename>poky</filename> Git repository, you have an active development repository. - In this case, any local changes you make to the Source Directory can be later applied - to active development branches of the upstream <filename>poky</filename> Git + In this case, any local changes you make to the Source Directory can be later applied + to active development branches of the upstream <filename>poky</filename> Git repository.</para> <para>Finally, if you want to track a set of local changes while starting from the same point - as a release tarball, you can create a local Git branch that - reflects the exact copy of the files at the time of their release. + as a release tarball, you can create a local Git branch that + reflects the exact copy of the files at the time of their release. You do this by using Git tags that are part of the repository.</para> <para>For more information on concepts around Git repositories, branches, and tags, - see the + see the "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>" section.</para></listitem> - <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes. - You simply use Tasks to hold recipes that, when built, usually accomplish a single task. - For example, a task could contain the recipes for a company’s proprietary or value-add software. - Or, the task could contain the recipes that enable graphics. - A task is really just another recipe. - Because task files are recipes, they end with the <filename>.bb</filename> filename + <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes. + You simply use Tasks to hold recipes that, when built, usually accomplish a single task. + For example, a task could contain the recipes for a company’s proprietary or value-add software. + Or, the task could contain the recipes that enable graphics. + A task is really just another recipe. + Because task files are recipes, they end with the <filename>.bb</filename> filename extension.</para></listitem> <listitem><para><emphasis>Upstream:</emphasis> A reference to source code or repositories that are not local to the development system but located in a master area that is controlled by the maintainer of the source code. - For example, in order for a developer to work on a particular piece of code, they need to + For example, in order for a developer to work on a particular piece of code, they need to first get a copy of it from an "upstream" source.</para></listitem> </itemizedlist> </para> @@ -446,8 +446,8 @@ <title>Licensing</title> <para> - Because open source projects are open to the public, they have different licensing structures in place. - License evolution for both Open Source and Free Software has an interesting history. + Because open source projects are open to the public, they have different licensing structures in place. + License evolution for both Open Source and Free Software has an interesting history. If you are interested in this history, you can find basic information here: <itemizedlist> <listitem><para><ulink url='http://en.wikipedia.org/wiki/Open-source_license'>Open source license history</ulink> @@ -458,57 +458,57 @@ </para> <para> - In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology - (MIT) License. - MIT licensing permits the reuse of software within proprietary software as long as the - license is distributed with that software. - MIT is also compatible with the GNU General Public License (GPL). + In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology + (MIT) License. + MIT licensing permits the reuse of software within proprietary software as long as the + license is distributed with that software. + MIT is also compatible with the GNU General Public License (GPL). Patches to the Yocto Project follow the upstream licensing scheme. - You can find information on the MIT license at + You can find information on the MIT license at <ulink url='http://www.opensource.org/licenses/mit-license.php'>here</ulink>. You can find information on the GNU GPL <ulink url='http://www.opensource.org/licenses/LGPL-3.0'> - here</ulink>. + here</ulink>. </para> <para> - When you build an image using the Yocto Project, the build process uses a + When you build an image using the Yocto Project, the build process uses a known list of licenses to ensure compliance. - You can find this list in the Yocto Project files directory at - <filename>meta/files/common-licenses</filename>. - Once the build completes, the list of all licenses found and used during that build are - kept in the - <link linkend='build-directory'>Build Directory</link> at + You can find this list in the Yocto Project files directory at + <filename>meta/files/common-licenses</filename>. + Once the build completes, the list of all licenses found and used during that build are + kept in the + <link linkend='build-directory'>Build Directory</link> at <filename>tmp/deploy/images/licenses</filename>. </para> - <para> - If a module requires a license that is not in the base list, the build process - generates a warning during the build. + <para> + If a module requires a license that is not in the base list, the build process + generates a warning during the build. These tools make it easier for a developer to be certain of the licenses with which their shipped products must comply. However, even with these tools it is still up to the developer to resolve potential licensing issues. </para> <para> - The base list of licenses used by the build process is a combination of the Software Package - Data Exchange (SPDX) list and the Open Source Initiative (OSI) projects. - <ulink url='http://spdx.org'>SPDX Group</ulink> is a working group of the Linux Foundation - that maintains a specification - for a standard format for communicating the components, licenses, and copyrights - associated with a software package. - <ulink url='http://opensource.org'>OSI</ulink> is a corporation dedicated to the Open Source - Definition and the effort for reviewing and approving licenses that are OSD-conformant. + The base list of licenses used by the build process is a combination of the Software Package + Data Exchange (SPDX) list and the Open Source Initiative (OSI) projects. + <ulink url='http://spdx.org'>SPDX Group</ulink> is a working group of the Linux Foundation + that maintains a specification + for a standard format for communicating the components, licenses, and copyrights + associated with a software package. + <ulink url='http://opensource.org'>OSI</ulink> is a corporation dedicated to the Open Source + Definition and the effort for reviewing and approving licenses that are OSD-conformant. </para> <para> - You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses + You can find a list of the combined SPDX and OSI licenses that the Yocto Project uses <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/files/common-licenses'>here</ulink>. This wiki page discusses the license infrastructure used by the Yocto Project. </para> <para> - For information that can help you to maintain compliance with various open source licensing - during the lifecycle of a product created using the Yocto Project, see the + For information that can help you to maintain compliance with various open source licensing + during the lifecycle of a product created using the Yocto Project, see the "<link linkend='maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</link>" section. </para> </section> @@ -517,45 +517,45 @@ <title>Git</title> <para> - The Yocto Project uses Git, which is a free, open source distributed version control system. - Git supports distributed development, non-linear development, and can handle large projects. - It is best that you have some fundamental understanding of how Git tracks projects and - how to work with Git if you are going to use Yocto Project for development. + The Yocto Project uses Git, which is a free, open source distributed version control system. + Git supports distributed development, non-linear development, and can handle large projects. + It is best that you have some fundamental understanding of how Git tracks projects and + how to work with Git if you are going to use Yocto Project for development. This section provides a quick overview of how Git works and provides you with a summary of some essential Git commands. </para> <para> For more information on Git, see - <ulink url='http://git-scm.com/documentation'></ulink>. - If you need to download Git, go to <ulink url='http://git-scm.com/download'></ulink>. + <ulink url='http://git-scm.com/documentation'></ulink>. + If you need to download Git, go to <ulink url='http://git-scm.com/download'></ulink>. </para> <section id='repositories-tags-and-branches'> <title>Repositories, Tags, and Branches</title> <para> - As mentioned earlier in section + As mentioned earlier in section "<link linkend='yocto-project-repositories'>Yocto Project Source Repositories</link>", - the Yocto Project maintains source repositories at + the Yocto Project maintains source repositories at <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. If you look at this web-interface of the repositories, each item is a separate Git repository. </para> <para> - Git repositories use branching techniques that track content change (not files) - within a project (e.g. a new feature or updated documentation). - Creating a tree-like structure based on project divergence allows for excellent historical - information over the life of a project. - This methodology also allows for an environment in which you can do lots of - local experimentation on a project as you develop changes or new features. + Git repositories use branching techniques that track content change (not files) + within a project (e.g. a new feature or updated documentation). + Creating a tree-like structure based on project divergence allows for excellent historical + information over the life of a project. + This methodology also allows for an environment in which you can do lots of + local experimentation on a project as you develop changes or new features. </para> <para> A Git repository represents all development efforts for a given project. For example, the Git repository <filename>poky</filename> contains all changes - and developments for Poky over the course of its entire life. + and developments for Poky over the course of its entire life. That means that all changes that make up all releases are captured. The repository maintains a complete history of changes. </para> @@ -563,8 +563,8 @@ <para> You can create a local copy of any repository by "cloning" it with the Git <filename>clone</filename> command. - When you clone a Git repository, you end up with an identical copy of the - repository on your development system. + When you clone a Git repository, you end up with an identical copy of the + repository on your development system. Once you have a local copy of a repository, you can take steps to develop locally. For examples on how to clone Git repositories, see the section "<link linkend='getting-setup'>Getting Set Up</link>" earlier in this manual. @@ -572,34 +572,34 @@ <para> It is important to understand that Git tracks content change and not files. - Git uses "branches" to organize different development efforts. - For example, the <filename>poky</filename> repository has - <filename>bernard</filename>, + Git uses "branches" to organize different development efforts. + For example, the <filename>poky</filename> repository has + <filename>bernard</filename>, <filename>edison</filename>, <filename>denzil</filename>, <filename>danny</filename> and <filename>master</filename> branches among others. - You can see all the branches by going to - <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and - clicking on the - <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/heads'>[...]</ulink></filename> + You can see all the branches by going to + <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and + clicking on the + <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/heads'>[...]</ulink></filename> link beneath the "Branch" heading. </para> <para> Each of these branches represents a specific area of development. - The <filename>master</filename> branch represents the current or most recent + The <filename>master</filename> branch represents the current or most recent development. All other branches represent off-shoots of the <filename>master</filename> - branch. + branch. </para> <para> - When you create a local copy of a Git repository, the copy has the same set + When you create a local copy of a Git repository, the copy has the same set of branches as the original. This means you can use Git to create a local working area (also called a branch) - that tracks a specific development branch from the source Git repository. + that tracks a specific development branch from the source Git repository. in other words, you can define your local Git environment to work on any development branch in the repository. - To help illustrate, here is a set of commands that creates a local copy of the + To help illustrate, here is a set of commands that creates a local copy of the <filename>poky</filename> Git repository and then creates and checks out a local Git branch that tracks the Yocto Project &DISTRO; Release (&DISTRO_NAME;) development: <literallayout class='monospaced'> @@ -608,20 +608,20 @@ $ cd poky $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; </literallayout> - In this example, the name of the top-level directory of your local Yocto Project + In this example, the name of the top-level directory of your local Yocto Project Files Git repository is <filename>poky</filename>, and the name of the local working area (or local branch) you have created and checked out is <filename>&DISTRO_NAME;</filename>. - The files in your repository now reflect the same files that are in the - <filename>&DISTRO_NAME;</filename> development branch of the Yocto Project's + The files in your repository now reflect the same files that are in the + <filename>&DISTRO_NAME;</filename> development branch of the Yocto Project's <filename>poky</filename> repository. - It is important to understand that when you create and checkout a - local working branch based on a branch name, + It is important to understand that when you create and checkout a + local working branch based on a branch name, your local environment matches the "tip" of that development branch at the time you created your local branch, which could be different than the files at the time of a similarly named release. - In other words, creating and checking out a local branch based on the - <filename>&DISTRO_NAME;</filename> branch name is not the same as + In other words, creating and checking out a local branch based on the + <filename>&DISTRO_NAME;</filename> branch name is not the same as cloning and checking out the <filename>master</filename> branch. Keep reading to see how you create a local snapshot of a Yocto Project Release. </para> @@ -629,11 +629,11 @@ <para> Git uses "tags" to mark specific changes in a repository. Typically, a tag is used to mark a special point such as the final change - before a project is released. + before a project is released. You can see the tags used with the <filename>poky</filename> Git repository - by going to <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and - clicking on the - <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/tags'>[...]</ulink></filename> + by going to <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/'></ulink> and + clicking on the + <filename><ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/refs/tags'>[...]</ulink></filename> link beneath the "Tag" heading. </para> @@ -644,14 +644,14 @@ </para> <para> - When you create a local copy of the Git repository, you also have access to all the + When you create a local copy of the Git repository, you also have access to all the tags. - Similar to branches, you can create and checkout a local working Git branch based - on a tag name. - When you do this, you get a snapshot of the Git repository that reflects + Similar to branches, you can create and checkout a local working Git branch based + on a tag name. + When you do this, you get a snapshot of the Git repository that reflects the state of the files when the change was made associated with that tag. - The most common use is to checkout a working branch that matches a specific - Yocto Project release. + The most common use is to checkout a working branch that matches a specific + Yocto Project release. Here is an example: <literallayout class='monospaced'> $ cd ~ @@ -659,101 +659,101 @@ $ cd poky $ git checkout -b my-&DISTRO_NAME;-&POKYVERSION; &DISTRO_NAME;-&POKYVERSION; </literallayout> - In this example, the name of the top-level directory of your local Yocto Project + In this example, the name of the top-level directory of your local Yocto Project Files Git repository is <filename>poky</filename>. And, the name of the local branch you have created and checked out is <filename>my-&DISTRO_NAME;-&POKYVERSION;</filename>. The files in your repository now exactly match the Yocto Project &DISTRO; Release tag (<filename>&DISTRO_NAME;-&POKYVERSION;</filename>). - It is important to understand that when you create and checkout a local - working branch based on a tag, your environment matches a specific point + It is important to understand that when you create and checkout a local + working branch based on a tag, your environment matches a specific point in time and not a development branch. </para> - </section> + </section> <section id='basic-commands'> <title>Basic Commands</title> <para> - Git has an extensive set of commands that lets you manage changes and perform - collaboration over the life of a project. - Conveniently though, you can manage with a small set of basic operations and workflows - once you understand the basic philosophy behind Git. - You do not have to be an expert in Git to be functional. - A good place to look for instruction on a minimal set of Git commands is - <ulink url='http://git-scm.com/documentation'>here</ulink>. - If you need to download Git, you can do so - <ulink url='http://git-scm.com/download'>here</ulink>. + Git has an extensive set of commands that lets you manage changes and perform + collaboration over the life of a project. + Conveniently though, you can manage with a small set of basic operations and workflows + once you understand the basic philosophy behind Git. + You do not have to be an expert in Git to be functional. + A good place to look for instruction on a minimal set of Git commands is + <ulink url='http://git-scm.com/documentation'>here</ulink>. + If you need to download Git, you can do so + <ulink url='http://git-scm.com/download'>here</ulink>. </para> <para> - If you don’t know much about Git, we suggest you educate + If you don’t know much about Git, we suggest you educate yourself by visiting the links previously mentioned. </para> <para> - The following list briefly describes some basic Git operations as a way to get started. - As with any set of commands, this list (in most cases) simply shows the base command and - omits the many arguments they support. + The following list briefly describes some basic Git operations as a way to get started. + As with any set of commands, this list (in most cases) simply shows the base command and + omits the many arguments they support. See the Git documentation for complete descriptions and strategies on how to use these commands: <itemizedlist> - <listitem><para><emphasis><filename>git init</filename>:</emphasis> Initializes an empty Git repository. + <listitem><para><emphasis><filename>git init</filename>:</emphasis> Initializes an empty Git repository. You cannot use Git commands unless you have a <filename>.git</filename> repository.</para></listitem> - <listitem><para><emphasis><filename>git clone</filename>:</emphasis> Creates a clone of a repository. - During collaboration, this command allows you to create a local repository that is on + <listitem><para><emphasis><filename>git clone</filename>:</emphasis> Creates a clone of a repository. + During collaboration, this command allows you to create a local repository that is on equal footing with a fellow developer’s repository.</para></listitem> - <listitem><para><emphasis><filename>git add</filename>:</emphasis> Adds updated file contents - to the index that - Git uses to track changes. + <listitem><para><emphasis><filename>git add</filename>:</emphasis> Adds updated file contents + to the index that + Git uses to track changes. You must add all files that have changed before you can commit them.</para></listitem> - <listitem><para><emphasis><filename>git commit</filename>:</emphasis> Creates a “commit” that documents - the changes you made. - Commits are used for historical purposes, for determining if a maintainer of a project - will allow the change, and for ultimately pushing the change from your local Git repository + <listitem><para><emphasis><filename>git commit</filename>:</emphasis> Creates a “commit” that documents + the changes you made. + Commits are used for historical purposes, for determining if a maintainer of a project + will allow the change, and for ultimately pushing the change from your local Git repository into the project’s upstream (or master) repository.</para></listitem> - <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that + <listitem><para><emphasis><filename>git status</filename>:</emphasis> Reports any modified files that possibly need to be added and committed.</para></listitem> - <listitem><para><emphasis><filename>git checkout <branch-name></filename>:</emphasis> Changes - your working branch. + <listitem><para><emphasis><filename>git checkout <branch-name></filename>:</emphasis> Changes + your working branch. This command is analogous to “cd”.</para></listitem> - <listitem><para><emphasis><filename>git checkout –b <working-branch></filename>:</emphasis> Creates - a working branch on your local machine where you can isolate work. - It is a good idea to use local branches when adding specific features or changes. + <listitem><para><emphasis><filename>git checkout –b <working-branch></filename>:</emphasis> Creates + a working branch on your local machine where you can isolate work. + It is a good idea to use local branches when adding specific features or changes. This way if you don’t like what you have done you can easily get rid of the work.</para></listitem> - <listitem><para><emphasis><filename>git branch</filename>:</emphasis> Reports - existing local branches and + <listitem><para><emphasis><filename>git branch</filename>:</emphasis> Reports + existing local branches and tells you the branch in which you are currently working.</para></listitem> - <listitem><para><emphasis><filename>git branch -D <branch-name></filename>:</emphasis> - Deletes an existing local branch. - You need to be in a local branch other than the one you are deleting + <listitem><para><emphasis><filename>git branch -D <branch-name></filename>:</emphasis> + Deletes an existing local branch. + You need to be in a local branch other than the one you are deleting in order to delete <filename><branch-name></filename>.</para></listitem> - <listitem><para><emphasis><filename>git pull</filename>:</emphasis> Retrieves information - from an upstream Git - repository and places it in your local Git repository. - You use this command to make sure you are synchronized with the repository + <listitem><para><emphasis><filename>git pull</filename>:</emphasis> Retrieves information + from an upstream Git + repository and places it in your local Git repository. + You use this command to make sure you are synchronized with the repository from which you are basing changes (.e.g. the master branch).</para></listitem> - <listitem><para><emphasis><filename>git push</filename>:</emphasis> Sends all your local changes you - have committed to an upstream Git repository (e.g. a contribution repository). - The maintainer of the project draws from these repositories when adding your changes to the + <listitem><para><emphasis><filename>git push</filename>:</emphasis> Sends all your local changes you + have committed to an upstream Git repository (e.g. a contribution repository). + The maintainer of the project draws from these repositories when adding your changes to the project’s master repository.</para></listitem> - <listitem><para><emphasis><filename>git merge</filename>:</emphasis> Combines or adds changes from one - local branch of your repository with another branch. - When you create a local Git repository, the default branch is named “master”. - A typical workflow is to create a temporary branch for isolated work, make and commit your - changes, switch to your local master branch, merge the changes from the temporary branch into the + <listitem><para><emphasis><filename>git merge</filename>:</emphasis> Combines or adds changes from one + local branch of your repository with another branch. + When you create a local Git repository, the default branch is named “master”. + A typical workflow is to create a temporary branch for isolated work, make and commit your + changes, switch to your local master branch, merge the changes from the temporary branch into the local master branch, and then delete the temporary branch.</para></listitem> - <listitem><para><emphasis><filename>git cherry-pick</filename>:</emphasis> Choose and apply specific - commits from one branch into another branch. - There are times when you might not be able to merge all the changes in one branch with + <listitem><para><emphasis><filename>git cherry-pick</filename>:</emphasis> Choose and apply specific + commits from one branch into another branch. + There are times when you might not be able to merge all the changes in one branch with another but need to pick out certain ones.</para></listitem> - <listitem><para><emphasis><filename>gitk</filename>:</emphasis> Provides a GUI view of the branches - and changes in your local Git repository. - This command is a good way to graphically see where things have diverged in your + <listitem><para><emphasis><filename>gitk</filename>:</emphasis> Provides a GUI view of the branches + and changes in your local Git repository. + This command is a good way to graphically see where things have diverged in your local repository.</para></listitem> - <listitem><para><emphasis><filename>git log</filename>:</emphasis> Reports a history of your changes to the + <listitem><para><emphasis><filename>git log</filename>:</emphasis> Reports a history of your changes to the repository.</para></listitem> <listitem><para><emphasis><filename>git diff</filename>:</emphasis> Displays line-by-line differences - between your local working files and the same files in the upstream Git repository that your + between your local working files and the same files in the upstream Git repository that your branch currently tracks.</para></listitem> </itemizedlist> </para> @@ -764,130 +764,130 @@ <title>Workflows</title> <para> - This section provides some overview on workflows using Git. - In particular, the information covers basic practices that describe roles and actions in a - collaborative development environment. - Again, if you are familiar with this type of development environment, you might want to just + This section provides some overview on workflows using Git. + In particular, the information covers basic practices that describe roles and actions in a + collaborative development environment. + Again, if you are familiar with this type of development environment, you might want to just skip this section. </para> <para> - The Yocto Project files are maintained using Git in a "master" branch whose Git history + The Yocto Project files are maintained using Git in a "master" branch whose Git history tracks every change and whose structure provides branches for all diverging functionality. Although there is no need to use Git, many open source projects do so. For the Yocto Project, a key individual called the "maintainer" is responsible for the "master" branch of the Git repository. - The "master" branch is the “upstream” repository where the final builds of the project occur. - The maintainer is responsible for allowing changes in from other developers and for - organizing the underlying branch structure to reflect release strategies and so forth. - <note>You can see who is the maintainer for Yocto Project files by examining the + The "master" branch is the “upstream” repository where the final builds of the project occur. + The maintainer is responsible for allowing changes in from other developers and for + organizing the underlying branch structure to reflect release strategies and so forth. + <note>You can see who is the maintainer for Yocto Project files by examining the <filename>maintainers.inc</filename> file in the Yocto Project <filename>meta-yocto/conf/distro/include</filename> directory.</note> </para> <para> - The project also has contribution repositories known as “contrib” areas. - These areas temporarily hold changes to the project that have been submitted or committed - by the Yocto Project development team and by community members that contribute to the project. + The project also has contribution repositories known as “contrib” areas. + These areas temporarily hold changes to the project that have been submitted or committed + by the Yocto Project development team and by community members that contribute to the project. The maintainer determines if the changes are qualified to be moved from the "contrib" areas into the "master" branch of the Git repository. </para> <para> - Developers (including contributing community members) create and maintain cloned repositories - of the upstream "master" branch. - These repositories are local to their development platforms and are used to develop changes. - When a developer is satisfied with a particular feature or change, they “push” the changes + Developers (including contributing community members) create and maintain cloned repositories + of the upstream "master" branch. + These repositories are local to their development platforms and are used to develop changes. + When a developer is satisfied with a particular feature or change, they “push” the changes to the appropriate "contrib" repository. </para> - <para> - Developers are responsible for keeping their local repository up-to-date with "master". - They are also responsible for straightening out any conflicts that might arise within files - that are being worked on simultaneously by more than one person. - All this work is done locally on the developer’s machine before anything is pushed to a + <para> + Developers are responsible for keeping their local repository up-to-date with "master". + They are also responsible for straightening out any conflicts that might arise within files + that are being worked on simultaneously by more than one person. + All this work is done locally on the developer’s machine before anything is pushed to a "contrib" area and examined at the maintainer’s level. </para> <para> - A somewhat formal method exists by which developers commit changes and push them into the - "contrib" area and subsequently request that the maintainer include them into "master" - This process is called “submitting a patch” or “submitting a change.” - For information on submitting patches and changes, see the + A somewhat formal method exists by which developers commit changes and push them into the + "contrib" area and subsequently request that the maintainer include them into "master" + This process is called “submitting a patch” or “submitting a change.” + For information on submitting patches and changes, see the "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" section. </para> <para> - To summarize the environment: we have a single point of entry for changes into the project’s - "master" branch of the Git repository, which is controlled by the project’s maintainer. - And, we have a set of developers who independently develop, test, and submit changes - to "contrib" areas for the maintainer to examine. + To summarize the environment: we have a single point of entry for changes into the project’s + "master" branch of the Git repository, which is controlled by the project’s maintainer. + And, we have a set of developers who independently develop, test, and submit changes + to "contrib" areas for the maintainer to examine. The maintainer then chooses which changes are going to become a permanent part of the project. </para> <para> <imagedata fileref="figures/git-workflow.png" width="6in" depth="3in" align="left" scalefit="1" /> - </para> + </para> <para> - While each development environment is unique, there are some best practices or methods - that help development run smoothly. - The following list describes some of these practices. - For more information about Git workflows, see the workflow topics in the - <ulink url='http://book.git-scm.com'>Git Community Book</ulink>. + While each development environment is unique, there are some best practices or methods + that help development run smoothly. + The following list describes some of these practices. + For more information about Git workflows, see the workflow topics in the + <ulink url='http://book.git-scm.com'>Git Community Book</ulink>. <itemizedlist> <listitem><para><emphasis>Make Small Changes:</emphasis> It is best to keep the changes you commit - small as compared to bundling many disparate changes into a single commit. - This practice not only keeps things manageable but also allows the maintainer + small as compared to bundling many disparate changes into a single commit. + This practice not only keeps things manageable but also allows the maintainer to more easily include or refuse changes.</para> - <para>It is also good practice to leave the repository in a state that allows you to + <para>It is also good practice to leave the repository in a state that allows you to still successfully build your project. In other words, do not commit half of a feature, - then add the other half in a separate, later commit. - Each commit should take you from one buildable project state to another + then add the other half in a separate, later commit. + Each commit should take you from one buildable project state to another buildable state.</para></listitem> - <listitem><para><emphasis>Use Branches Liberally:</emphasis> It is very easy to create, use, and - delete local branches in your working Git repository. - You can name these branches anything you like. - It is helpful to give them names associated with the particular feature or change - on which you are working. + <listitem><para><emphasis>Use Branches Liberally:</emphasis> It is very easy to create, use, and + delete local branches in your working Git repository. + You can name these branches anything you like. + It is helpful to give them names associated with the particular feature or change + on which you are working. Once you are done with a feature or change, simply discard the branch.</para></listitem> <listitem><para><emphasis>Merge Changes:</emphasis> The <filename>git merge</filename> - command allows you to take the - changes from one branch and fold them into another branch. - This process is especially helpful when more than a single developer might be working - on different parts of the same feature. - Merging changes also automatically identifies any collisions or “conflicts” - that might happen as a result of the same lines of code being altered by two different + command allows you to take the + changes from one branch and fold them into another branch. + This process is especially helpful when more than a single developer might be working + on different parts of the same feature. + Merging changes also automatically identifies any collisions or “conflicts” + that might happen as a result of the same lines of code being altered by two different developers.</para></listitem> - <listitem><para><emphasis>Manage Branches:</emphasis> Because branches are easy to use, you should - use a system where branches indicate varying levels of code readiness. - For example, you can have a “work” branch to develop in, a “test” branch where the code or - change is tested, a “stage” branch where changes are ready to be committed, and so forth. - As your project develops, you can merge code across the branches to reflect ever-increasing + <listitem><para><emphasis>Manage Branches:</emphasis> Because branches are easy to use, you should + use a system where branches indicate varying levels of code readiness. + For example, you can have a “work” branch to develop in, a “test” branch where the code or + change is tested, a “stage” branch where changes are ready to be committed, and so forth. + As your project develops, you can merge code across the branches to reflect ever-increasing stable states of the development.</para></listitem> - <listitem><para><emphasis>Use Push and Pull:</emphasis> The push-pull workflow is based on the - concept of developers “pushing” local commits to a remote repository, which is - usually a contribution repository. - This workflow is also based on developers “pulling” known states of the project down into their - local development repositories. - The workflow easily allows you to pull changes submitted by other developers from the - upstream repository into your work area ensuring that you have the most recent software + <listitem><para><emphasis>Use Push and Pull:</emphasis> The push-pull workflow is based on the + concept of developers “pushing” local commits to a remote repository, which is + usually a contribution repository. + This workflow is also based on developers “pulling” known states of the project down into their + local development repositories. + The workflow easily allows you to pull changes submitted by other developers from the + upstream repository into your work area ensuring that you have the most recent software on which to develop. - The Yocto Project has two scripts named <filename>create-pull-request</filename> and - <filename>send-pull-request</filename> that ship with the release to facilitate this + The Yocto Project has two scripts named <filename>create-pull-request</filename> and + <filename>send-pull-request</filename> that ship with the release to facilitate this workflow. You can find these scripts in the local Yocto Project files Git repository in the <filename>scripts</filename> directory.</para> - <para>You can find more information on these scripts in the + <para>You can find more information on these scripts in the "<link linkend='pushing-a-change-upstream'>Using Scripts to Push a Change Upstream and Request a Pull</link>" section. </para></listitem> - <listitem><para><emphasis>Patch Workflow:</emphasis> This workflow allows you to notify the - maintainer through an email that you have a change (or patch) you would like considered - for the "master" branch of the Git repository. - To send this type of change you format the patch and then send the email using the Git commands - <filename>git format-patch</filename> and <filename>git send-email</filename>. - You can find information on how to submit changes + <listitem><para><emphasis>Patch Workflow:</emphasis> This workflow allows you to notify the + maintainer through an email that you have a change (or patch) you would like considered + for the "master" branch of the Git repository. + To send this type of change you format the patch and then send the email using the Git commands + <filename>git format-patch</filename> and <filename>git send-email</filename>. + You can find information on how to submit changes later in this chapter.</para></listitem> </itemizedlist> </para> @@ -897,24 +897,24 @@ <title>Tracking Bugs</title> <para> - The Yocto Project uses its own implementation of - <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs. - Implementations of Bugzilla work well for group development because they track bugs and code - changes, can be used to communicate changes and problems with developers, can be used to - submit and review patches, and can be used to manage quality assurance. - The home page for the Yocto Project implementation of Bugzilla is + The Yocto Project uses its own implementation of + <ulink url='http://www.bugzilla.org/about/'>Bugzilla</ulink> to track bugs. + Implementations of Bugzilla work well for group development because they track bugs and code + changes, can be used to communicate changes and problems with developers, can be used to + submit and review patches, and can be used to manage quality assurance. + The home page for the Yocto Project implementation of Bugzilla is <ulink url='&YOCTO_BUGZILLA_URL;'>&YOCTO_BUGZILLA_URL;</ulink>. </para> <para> Sometimes it is helpful to submit, investigate, or track a bug against the Yocto Project itself - such as when discovering an issue with some component of the build system that acts contrary - to the documentation or your expectations. + such as when discovering an issue with some component of the build system that acts contrary + to the documentation or your expectations. Following is the general procedure for submitting a new bug using the Yocto Project Bugzilla. You can find more information on defect management, bug tracking, and feature request processes all accomplished through the Yocto Project Bugzilla on the wiki page - <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>. + <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>here</ulink>. <orderedlist> <listitem><para>Always use the Yocto Project implementation of Bugzilla to submit a bug.</para></listitem> @@ -922,21 +922,21 @@ Classification, Product, and Component for which the issue was found. Defects for Yocto Project fall into one of six classifications: Yocto Project Components, Infrastructure, Build System & Metadata, Documentation, - QA/Testing, and Runtime. - Each of these Classifications break down into multiple Products and, in some + QA/Testing, and Runtime. + Each of these Classifications break down into multiple Products and, in some cases, multiple Components.</para></listitem> <listitem><para>Use the bug form to choose the correct Hardware and Architecture for which the bug applies.</para></listitem> <listitem><para>Indicate the Yocto Project version you were using when the issue occurred.</para></listitem> - <listitem><para>Be sure to indicate the Severity of the bug. + <listitem><para>Be sure to indicate the Severity of the bug. Severity communicates how the bug impacted your work.</para></listitem> - <listitem><para>Provide a brief summary of the issue. - Try to limit your summary to just a line or two and be sure to capture the + <listitem><para>Provide a brief summary of the issue. + Try to limit your summary to just a line or two and be sure to capture the essence of the issue.</para></listitem> - <listitem><para>Provide a detailed description of the issue. - You should provide as much detail as you can about the context, behavior, output, - and so forth that surround the issue. + <listitem><para>Provide a detailed description of the issue. + You should provide as much detail as you can about the context, behavior, output, + and so forth that surround the issue. You can even attach supporting files for output or log by using the "Add an attachment" button.</para></listitem> <listitem><para>Submit the bug by clicking the "Submit Bug" button.</para></listitem> @@ -954,7 +954,7 @@ You should send patches to the appropriate mailing list so that they can be reviewed and merged by the appropriate maintainer. For a list of the Yocto Project and related mailing lists, see the - "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in + "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in the Yocto Project Reference Manual. </para> @@ -971,7 +971,7 @@ <ulink url='&OE_LISTS_URL;/listinfo/bitbake-devel'>bitbake-devel</ulink> mailing list.</para></listitem> <listitem><para>For changes to <filename>meta-yocto</filename>, send your patch to the <ulink url='&YOCTO_LISTS_URL;/listinfo/poky'>poky</ulink> mailing list.</para></listitem> - <listitem><para>For changes to other layers hosted on + <listitem><para>For changes to other layers hosted on <filename>yoctoproject.org</filename> (unless the layer's documentation specifies otherwise), tools, and Yocto Project documentation, use the @@ -983,12 +983,12 @@ <ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'>yocto</ulink> or <ulink url='&OE_LISTS_URL;/listinfo/openembedded-devel'>openembedded-devel</ulink> mailing lists.</para></listitem> - </itemizedlist> + </itemizedlist> </para> - <para> + <para> When you send a patch, be sure to include a "Signed-off-by:" - line in the same style as required by the Linux kernel. + line in the same style as required by the Linux kernel. Adding this line signifies that you, the submitter, have agreed to the Developer's Certificate of Origin 1.1 as follows: <literallayout class='monospaced'> @@ -1021,8 +1021,8 @@ </para> <para> - In a collaborative environment, it is necessary to have some sort of standard - or method through which you submit changes. + In a collaborative environment, it is necessary to have some sort of standard + or method through which you submit changes. Otherwise, things could get quite chaotic. One general practice to follow is to make small, controlled changes. Keeping changes small and isolated aids review, makes merging/rebasing easier @@ -1035,14 +1035,14 @@ For each commit, you must provide a single-line summary of the change and you should almost always provide a more detailed description of what you did (i.e. the body of the commit message). - The only exceptions for not providing a detailed description would be if your - change is a simple, self-explanatory change that needs no further description + The only exceptions for not providing a detailed description would be if your + change is a simple, self-explanatory change that needs no further description beyond the summary. Here are the guidelines for composing a commit message: <itemizedlist> <listitem><para>Provide a single-line, short summary of the change. This summary is typically viewable in the "shortlist" of changes. - Thus, providing something short and descriptive that gives the reader + Thus, providing something short and descriptive that gives the reader a summary of the change is useful when viewing a list of many commits. This should be prefixed by the recipe name (if changing a recipe), or else the short form path to the file being changed. @@ -1052,7 +1052,7 @@ you used. It may also be helpful if you mention how you tested the change. Provide as much detail as you can in the body of the commit message. </para></listitem> - <listitem><para>If the change addresses a specific bug or issue that is + <listitem><para>If the change addresses a specific bug or issue that is associated with a bug-tracking ID, include a reference to that ID in your detailed description. For example, the Yocto Project uses a specific convention for bug @@ -1069,15 +1069,15 @@ </para> <para> - You can find more guidance on creating well-formed commit messages at this OpenEmbedded + You can find more guidance on creating well-formed commit messages at this OpenEmbedded wiki page: <ulink url='&OE_HOME_URL;/wiki/Commit_Patch_Message_Guidelines'></ulink>. </para> <para> - Following are general instructions for both pushing changes upstream and for submitting + Following are general instructions for both pushing changes upstream and for submitting changes as patches. - </para> + </para> <section id='pushing-a-change-upstream'> <title>Using Scripts to Push a Change Upstream and Request a Pull</title> @@ -1089,23 +1089,23 @@ <listitem><para>Stage your changes by using the <filename>git add</filename> command on each file you changed.</para></listitem> <listitem><para>Commit the change by using the <filename>git commit</filename> - command and push it to the "contrib" repository. + command and push it to the "contrib" repository. Be sure to provide a commit message that follows the project’s commit message standards as described earlier.</para></listitem> - <listitem><para>Notify the maintainer that you have pushed a change by making a pull + <listitem><para>Notify the maintainer that you have pushed a change by making a pull request. The Yocto Project provides two scripts that conveniently let you generate and send pull requests to the Yocto Project. - These scripts are <filename>create-pull-request</filename> and + These scripts are <filename>create-pull-request</filename> and <filename>send-pull-request</filename>. - You can find these scripts in the <filename>scripts</filename> directory + You can find these scripts in the <filename>scripts</filename> directory within the <link linkend='source-directory'>Source Directory</link>.</para> <para>Using these scripts correctly formats the requests without introducing any whitespace or HTML formatting. - The maintainer that receives your patches needs to be able to save and apply them + The maintainer that receives your patches needs to be able to save and apply them directly from your emails. Using these scripts is the preferred method for sending patches.</para> - <para>For help on using these scripts, simply provide the + <para>For help on using these scripts, simply provide the <filename>-h</filename> argument as follows: <literallayout class='monospaced'> $ ~/poky/scripts/create-pull-request -h @@ -1114,8 +1114,8 @@ </itemizedlist> </para> - <para> - You can find general Git information on how to push a change upstream in the + <para> + You can find general Git information on how to push a change upstream in the <ulink url='http://book.git-scm.com/3_distributed_workflows.html'>Git Community Book</ulink>. </para> </section> @@ -1124,7 +1124,7 @@ <title>Using Email to Submit a Patch</title> <para> - You can submit patches without using the <filename>create-pull-request</filename> and + You can submit patches without using the <filename>create-pull-request</filename> and <filename>send-pull-request</filename> scripts described in the previous section. Keep in mind, the preferred method is to use the scripts, however. </para> @@ -1132,7 +1132,7 @@ <para> Depending on the components changed, you need to submit the email to a specific mailing list. - For some guidance on which mailing list to use, see the list in the + For some guidance on which mailing list to use, see the list in the "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" section earlier in this manual. For a description of the available mailing lists, see @@ -1140,71 +1140,71 @@ section in the Yocto Project Reference Manual. </para> - <para> - Here is the general procedure on how to submit a patch through email without using the + <para> + Here is the general procedure on how to submit a patch through email without using the scripts: <itemizedlist> <listitem><para>Make your changes in your local Git repository.</para></listitem> <listitem><para>Stage your changes by using the <filename>git add</filename> command on each file you changed.</para></listitem> - <listitem><para>Commit the change by using the + <listitem><para>Commit the change by using the <filename>git commit --signoff</filename> command. - Using the <filename>--signoff</filename> option identifies you as the person - making the change and also satisfies the Developer's Certificate of + Using the <filename>--signoff</filename> option identifies you as the person + making the change and also satisfies the Developer's Certificate of Origin (DCO) shown earlier.</para> - <para>When you form a commit you must follow certain standards established by the - Yocto Project development team. + <para>When you form a commit you must follow certain standards established by the + Yocto Project development team. See the earlier section - "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" + "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" for Yocto Project commit message standards.</para></listitem> <listitem><para>Format the commit into an email message. To format commits, use the <filename>git format-patch</filename> command. When you provide the command, you must include a revision list or a number of patches as part of the command. - For example, these two commands each take the most recent single commit and - format it as an email message in the current directory: + For example, these two commands each take the most recent single commit and + format it as an email message in the current directory: <literallayout class='monospaced'> $ git format-patch -1 $ git format-patch HEAD~ </literallayout></para> - <para>After the command is run, the current directory contains a + <para>After the command is run, the current directory contains a numbered <filename>.patch</filename> file for the commit.</para> - <para>If you provide several commits as part of the command, - the <filename>git format-patch</filename> command produces a numbered + <para>If you provide several commits as part of the command, + the <filename>git format-patch</filename> command produces a numbered series of files in the current directory – one for each commit. - If you have more than one patch, you should also use the - <filename>--cover</filename> option with the command, which generates a - cover letter as the first "patch" in the series. - You can then edit the cover letter to provide a description for + If you have more than one patch, you should also use the + <filename>--cover</filename> option with the command, which generates a + cover letter as the first "patch" in the series. + You can then edit the cover letter to provide a description for the series of patches. - For information on the <filename>git format-patch</filename> command, - see <filename>GIT_FORMAT_PATCH(1)</filename> displayed using the + For information on the <filename>git format-patch</filename> command, + see <filename>GIT_FORMAT_PATCH(1)</filename> displayed using the <filename>man git-format-patch</filename> command.</para> <note>If you are or will be a frequent contributor to the Yocto Project - or to OpenEmbedded, you might consider requesting a contrib area and the + or to OpenEmbedded, you might consider requesting a contrib area and the necessary associated rights.</note></listitem> - <listitem><para>Import the files into your mail client by using the + <listitem><para>Import the files into your mail client by using the <filename>git send-email</filename> command. - <note>In order to use <filename>git send-email</filename>, you must have the + <note>In order to use <filename>git send-email</filename>, you must have the the proper Git packages installed. For Ubuntu and Fedora the package is <filename>git-email</filename>.</note></para> <para>The <filename>git send-email</filename> command sends email by using a local - or remote Mail Transport Agent (MTA) such as + or remote Mail Transport Agent (MTA) such as <filename>msmtp</filename>, <filename>sendmail</filename>, or through a direct <filename>smtp</filename> configuration in your Git <filename>config</filename> file. If you are submitting patches through email only, it is very important - that you submit them without any whitespace or HTML formatting that + that you submit them without any whitespace or HTML formatting that either you or your mailer introduces. - The maintainer that receives your patches needs to be able to save and + The maintainer that receives your patches needs to be able to save and apply them directly from your emails. - A good way to verify that what you are sending will be applicable by the - maintainer is to do a dry run and send them to yourself and then + A good way to verify that what you are sending will be applicable by the + maintainer is to do a dry run and send them to yourself and then save and apply them as the maintainer would.</para> <para>The <filename>git send-email</filename> command is the preferred method for sending your patches since there is no risk of compromising whitespace in the body of the message, which can occur when you use your own mail client. - The command also has several options that let you + The command also has several options that let you specify recipients and perform further editing of the email message. For information on how to use the <filename>git send-email</filename> command, use the <filename>man git-send-email</filename> command.</para></listitem> diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 11d4adca9f..299a02d581 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -7,14 +7,14 @@ <title>Getting Started with the Yocto Project</title> <para> - This chapter introduces the Yocto Project and gives you an idea of what you need to get started. - You can find enough information to set up your development host and build or use images for - hardware supported by the Yocto Project by reading the + This chapter introduces the Yocto Project and gives you an idea of what you need to get started. + You can find enough information to set up your development host and build or use images for + hardware supported by the Yocto Project by reading the <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. </para> <para> - The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides + The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides some higher-level concepts you might want to consider. </para> @@ -22,24 +22,24 @@ <title>Introducing the Yocto Project</title> <para> - The Yocto Project is an open-source collaboration project focused on embedded Linux development. - The project currently provides a build system, which is + The Yocto Project is an open-source collaboration project focused on embedded Linux development. + The project currently provides a build system, which is referred to as the OpenEmbedded build system in the Yocto Project documentation. - The Yocto Project provides various ancillary tools suitable for the embedded developer - and also features the Sato reference User Interface, which is optimized for + The Yocto Project provides various ancillary tools suitable for the embedded developer + and also features the Sato reference User Interface, which is optimized for stylus driven, low-resolution screens. </para> <para> - You can use the OpenEmbedded build system, which uses - BitBake to develop complete Linux - images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, - x86 and x86-64. + You can use the OpenEmbedded build system, which uses + BitBake to develop complete Linux + images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, + x86 and x86-64. While the Yocto Project does not provide a strict testing framework, - it does provide or generate for you artifacts that let you perform target-level and - emulated testing and debugging. + it does provide or generate for you artifacts that let you perform target-level and + emulated testing and debugging. Additionally, if you are an <trademark class='trade'>Eclipse</trademark> - IDE user, you can install an Eclipse Yocto Plug-in to allow you to + IDE user, you can install an Eclipse Yocto Plug-in to allow you to develop within that familiar environment. </para> </section> @@ -50,59 +50,59 @@ <para> Here is what you need to get set up to use the Yocto Project: <itemizedlist> - <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current + <listitem><para><emphasis>Host System:</emphasis> You should have a reasonably current Linux-based host system. - You will have the best results with a recent release of Fedora, + You will have the best results with a recent release of Fedora, OpenSUSE, Ubuntu, or CentOS as these releases are frequently tested against the Yocto Project - and officially supported. + and officially supported. For a list of the distributions under validation and their status, see the "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section - in the Yocto Project Reference Manual and the wiki page at + in the Yocto Project Reference Manual and the wiki page at <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink>.</para> <para> You should also have about 100 gigabytes of free disk space for building images. </para></listitem> <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system - requires certain packages exist on your development system (e.g. Python 2.6 or 2.7). - See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" + requires certain packages exist on your development system (e.g. Python 2.6 or 2.7). + See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section in the Yocto Project Quick Start for the exact package - requirements and the installation commands to install them + requirements and the installation commands to install them for the supported distributions.</para></listitem> - <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> - You need a release of the Yocto Project. + <listitem id='local-yp-release'><para><emphasis>Yocto Project Release:</emphasis> + You need a release of the Yocto Project. You set up a with local <link linkend='source-directory'>Source Directory</link> - one of two ways depending on whether you + one of two ways depending on whether you are going to contribute back into the Yocto Project or not. <note> Regardless of the method you use, this manual refers to the resulting local hierarchical set of files as the "Source Directory." </note> <itemizedlist> - <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute - back into the Yocto Project, you can simply download a Yocto Project release you want + <listitem><para><emphasis>Tarball Extraction:</emphasis> If you are not going to contribute + back into the Yocto Project, you can simply download a Yocto Project release you want from the website’s <ulink url='&YOCTO_HOME_URL;/download'>download page</ulink>. Once you have the tarball, just extract it into a directory of your choice.</para> - <para>For example, the following command extracts the Yocto Project &DISTRO; - release tarball + <para>For example, the following command extracts the Yocto Project &DISTRO; + release tarball into the current working directory and sets up the local Source Directory with a top-level folder named <filename>&YOCTO_POKY;</filename>: <literallayout class='monospaced'> $ tar xfj &YOCTO_POKY_TARBALL; </literallayout></para> - <para>This method does not produce a local Git repository. + <para>This method does not produce a local Git repository. Instead, you simply end up with a snapshot of the release.</para></listitem> <listitem><para><emphasis>Git Repository Method:</emphasis> If you are going to be contributing back into the Yocto Project or you simply want to keep up with the latest developments, you should use Git commands to set up a local Git repository of the upstream <filename>poky</filename> source repository. - Doing so creates a repository with a complete history of changes and allows + Doing so creates a repository with a complete history of changes and allows you to easily submit your changes upstream to the project. Because you cloned the repository, you have access to all the Yocto Project development branches and tag names used in the upstream repository.</para> - <para>The following transcript shows how to clone the <filename>poky</filename> + <para>The following transcript shows how to clone the <filename>poky</filename> Git repository into the current working directory. <note>You can view the Yocto Project Source Repositories at - <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> + <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink></note> The command creates the local repository in a directory named <filename>poky</filename>. For information on Git used within the Yocto Project, see the "<link linkend='git'>Git</link>" section. @@ -120,27 +120,27 @@ wiki page</ulink>, which describes how to create both <filename>poky</filename> and <filename>meta-intel</filename> Git repositories.</para></listitem> </itemizedlist></para></listitem> - <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> - If you are going to be making modifications to a supported Yocto Project kernel, you + <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> + If you are going to be making modifications to a supported Yocto Project kernel, you need to establish local copies of the source. You can find Git repositories of supported Yocto Project Kernels organized under "Yocto Linux Kernel" in the Yocto Project Source Repositories at <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> - <para>This setup can involve creating a bare clone of the Yocto Project kernel and then + <para>This setup can involve creating a bare clone of the Yocto Project kernel and then copying that cloned repository. You can create the bare clone and the copy of the bare clone anywhere you like. - For simplicity, it is recommended that you create these structures outside of the + For simplicity, it is recommended that you create these structures outside of the Source Directory (usually <filename>poky</filename>).</para> <para>As an example, the following transcript shows how to create the bare clone - of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of + of the <filename>linux-yocto-3.4</filename> kernel and then create a copy of that clone. - <note>When you have a local Yocto Project kernel Git repository, you can - reference that repository rather than the upstream Git repository as + <note>When you have a local Yocto Project kernel Git repository, you can + reference that repository rather than the upstream Git repository as part of the <filename>clone</filename> command. Doing so can speed up the process.</note></para> - <para>In the following example, the bare clone is named - <filename>linux-yocto-3.4.git</filename>, while the - copy is named <filename>my-linux-yocto-3.4-work</filename>: + <para>In the following example, the bare clone is named + <filename>linux-yocto-3.4.git</filename>, while the + copy is named <filename>my-linux-yocto-3.4-work</filename>: <literallayout class='monospaced'> $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.4 linux-yocto-3.4.git Initialized empty Git repository in /home/scottrif/linux-yocto-3.4.git/ @@ -158,20 +158,20 @@ </literallayout></para></listitem> <listitem id='poky-extras-repo'><para><emphasis> The <filename>poky-extras</filename> Git Repository</emphasis>: - The <filename>poky-extras</filename> Git repository contains metadata needed + The <filename>poky-extras</filename> Git repository contains metadata needed only if you are modifying and building the kernel image. In particular, it contains the kernel BitBake append (<filename>.bbappend</filename>) - files that you + files that you edit to point to your locally modified kernel source files and to build the kernel - image. - Pointing to these local files is much more efficient than requiring a download of the + image. + Pointing to these local files is much more efficient than requiring a download of the kernel's source files from upstream each time you make changes to the kernel.</para> - <para>You can find the <filename>poky-extras</filename> Git Repository in the - "Yocto Metadata Layers" area of the Yocto Project Source Repositories at + <para>You can find the <filename>poky-extras</filename> Git Repository in the + "Yocto Metadata Layers" area of the Yocto Project Source Repositories at <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. It is good practice to create this Git repository inside the Source Directory.</para> - <para>Following is an example that creates the <filename>poky-extras</filename> Git - repository inside the Source Directory, which is named <filename>poky</filename> + <para>Following is an example that creates the <filename>poky-extras</filename> Git + repository inside the Source Directory, which is named <filename>poky</filename> in this case: <literallayout class='monospaced'> $ cd ~/poky @@ -183,21 +183,21 @@ Receiving objects: 100% (618/618), 526.26 KiB | 111 KiB/s, done. Resolving deltas: 100% (192/192), done. </literallayout></para></listitem> - <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board - Support Packages (BSPs):</emphasis> - The Yocto Project provides a layer called <filename>meta-intel</filename> and + <listitem><para id='supported-board-support-packages-(bsps)'><emphasis>Supported Board + Support Packages (BSPs):</emphasis> + The Yocto Project provides a layer called <filename>meta-intel</filename> and it is maintained in its own separate Git repository. - The <filename>meta-intel</filename> layer contains many supported + The <filename>meta-intel</filename> layer contains many supported <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>.</para> <para>Similar considerations exist for setting up the <filename>meta-intel</filename> - layer. + layer. You can get set up for BSP development one of two ways: tarball extraction or with a local Git repository. It is a good idea to use the same method that you used to set up the Source Directory. - Regardless of the method you use, the Yocto Project uses the following BSP layer + Regardless of the method you use, the Yocto Project uses the following BSP layer naming scheme: - <literallayout class='monospaced'> - meta-<BSP_name> + <literallayout class='monospaced'> + meta-<BSP_name> </literallayout> where <filename><BSP_name></filename> is the recognized BSP name. Here are some examples: @@ -211,22 +211,22 @@ section in the Yocto Project Board Support Package (BSP) Developer's Guide for more information on BSP Layers. <itemizedlist> - <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released - BSP tarball from the same - <ulink url='&YOCTO_HOME_URL;/download'>download site</ulink> used - to get the Yocto Project release. + <listitem><para><emphasis>Tarball Extraction:</emphasis> You can download any released + BSP tarball from the same + <ulink url='&YOCTO_HOME_URL;/download'>download site</ulink> used + to get the Yocto Project release. Once you have the tarball, just extract it into a directory of your choice. Again, this method just produces a snapshot of the BSP layer in the form of a hierarchical directory structure.</para></listitem> - <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working - with a local Git repository for your Source Directory, you should also use this method + <listitem><para><emphasis>Git Repository Method:</emphasis> If you are working + with a local Git repository for your Source Directory, you should also use this method to set up the <filename>meta-intel</filename> Git repository. - You can locate the <filename>meta-intel</filename> Git repository in the + You can locate the <filename>meta-intel</filename> Git repository in the "Yocto Metadata Layers" area of the Yocto Project Source Repositories at <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.</para> <para>Typically, you set up the <filename>meta-intel</filename> Git repository inside the Source Directory. - For example, the following transcript shows the steps to clone the + For example, the following transcript shows the steps to clone the <filename>meta-intel</filename> Git repository inside the local <filename>poky</filename> Git repository. <literallayout class='monospaced'> @@ -239,15 +239,15 @@ Receiving objects: 100% (3380/3380), 1.77 MiB | 128 KiB/s, done. Resolving deltas: 100% (1689/1689), done. </literallayout></para> - <para>The same + <para>The same <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP'> - wiki page</ulink> referenced earlier covers how to + wiki page</ulink> referenced earlier covers how to set up the <filename>meta-intel</filename> Git repository.</para></listitem> </itemizedlist></para></listitem> - <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing + <listitem><para><emphasis>Eclipse Yocto Plug-in:</emphasis> If you are developing applications using the Eclipse Integrated Development Environment (IDE), - you will need this plug-in. - See the + you will need this plug-in. + See the "<link linkend='setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</link>" section for more information.</para></listitem> </itemizedlist> @@ -258,8 +258,8 @@ <title>Building Images</title> <para> - The build process creates an entire Linux distribution, including the toolchain, from source. - For more information on this topic, see the + The build process creates an entire Linux distribution, including the toolchain, from source. + For more information on this topic, see the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section in the Yocto Project Quick Start. </para> @@ -267,27 +267,27 @@ <para> The build process is as follows: <orderedlist> - <listitem><para>Make sure you have set up the Source Directory described in the + <listitem><para>Make sure you have set up the Source Directory described in the previous section.</para></listitem> - <listitem><para>Initialize the build environment by sourcing a build environment + <listitem><para>Initialize the build environment by sourcing a build environment script.</para></listitem> <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, - which is found in the - <link linkend='build-directory'>Build Directory</link>, - is set up how you want it. - This file defines many aspects of the build environment including - the target machine architecture through the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, - the development machine's processor use through the - <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and + which is found in the + <link linkend='build-directory'>Build Directory</link>, + is set up how you want it. + This file defines many aspects of the build environment including + the target machine architecture through the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, + the development machine's processor use through the + <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and - a centralized tarball download directory through the + a centralized tarball download directory through the <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> <listitem><para>Build the image using the <filename>bitbake</filename> command. - If you want information on BitBake, see the user manual inculded in the - <filename>bitbake/doc/manual</filename> directory of the + If you want information on BitBake, see the user manual inculded in the + <filename>bitbake/doc/manual</filename> directory of the <link linkend='source-directory'>Source Directory</link>.</para></listitem> - <listitem><para>Run the image either on the actual hardware or using the QEMU + <listitem><para>Run the image either on the actual hardware or using the QEMU emulator.</para></listitem> </orderedlist> </para> @@ -297,8 +297,8 @@ <title>Using Pre-Built Binaries and QEMU</title> <para> - Another option you have to get started is to use pre-built binaries. - The Yocto Project provides many types of binaries with each release. + Another option you have to get started is to use pre-built binaries. + The Yocto Project provides many types of binaries with each release. See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in the Yocto Project Reference Manual for descriptions of the types of binaries that ship with a Yocto Project @@ -306,51 +306,51 @@ </para> <para> - Using a pre-built binary is ideal for developing software applications to run on your - target hardware. - To do this, you need to be able to access the appropriate cross-toolchain tarball for - the architecture on which you are developing. - If you are using an SDK type image, the image ships with the complete toolchain native to - the architecture. - If you are not using an SDK type image, you need to separately download and + Using a pre-built binary is ideal for developing software applications to run on your + target hardware. + To do this, you need to be able to access the appropriate cross-toolchain tarball for + the architecture on which you are developing. + If you are using an SDK type image, the image ships with the complete toolchain native to + the architecture. + If you are not using an SDK type image, you need to separately download and install the stand-alone Yocto Project cross-toolchain tarball. </para> <para> - Regardless of the type of image you are using, you need to download the pre-built kernel - that you will boot in the QEMU emulator and then download and extract the target root + Regardless of the type of image you are using, you need to download the pre-built kernel + that you will boot in the QEMU emulator and then download and extract the target root filesystem for your target machine’s architecture. You can get architecture-specific binaries and filesystems from <ulink url='&YOCTO_MACHINES_DL_URL;'>machines</ulink>. You can get installation scripts for stand-alone toolchains from <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchains</ulink>. - Once you have all your files, you set up the environment to emulate the hardware - by sourcing an environment setup script. + Once you have all your files, you set up the environment to emulate the hardware + by sourcing an environment setup script. Finally, you start the QEMU emulator. - You can find details on all these steps in the + You can find details on all these steps in the "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" - section of the Yocto Project Quick Start. + section of the Yocto Project Quick Start. </para> - <para> + <para> Using QEMU to emulate your hardware can result in speed issues depending on the target and host architecture mix. - For example, using the <filename>qemux86</filename> image in the emulator - on an Intel-based 32-bit (x86) host machine is fast because the target and + For example, using the <filename>qemux86</filename> image in the emulator + on an Intel-based 32-bit (x86) host machine is fast because the target and host architectures match. On the other hand, using the <filename>qemuarm</filename> image on the same Intel-based host can be slower. - But, you still achieve faithful emulation of ARM-specific issues. + But, you still achieve faithful emulation of ARM-specific issues. </para> <para> To speed things up, the QEMU images support using <filename>distcc</filename> - to call a cross-compiler outside the emulated system. + to call a cross-compiler outside the emulated system. If you used <filename>runqemu</filename> to start QEMU, and the - <filename>distccd</filename> application is present on the host system, any + <filename>distccd</filename> application is present on the host system, any BitBake cross-compiling toolchain available from the build system is automatically used from within QEMU simply by calling <filename>distcc</filename>. - You can accomplish this by defining the cross-compiler variable + You can accomplish this by defining the cross-compiler variable (e.g. <filename>export CC="distcc"</filename>). Alternatively, if you are using a suitable SDK image or the appropriate stand-alone toolchain is present in <filename>/opt/poky</filename>, @@ -358,27 +358,27 @@ </para> <note> - Several mechanisms exist that let you connect to the system running on the + Several mechanisms exist that let you connect to the system running on the QEMU emulator: <itemizedlist> - <listitem><para>QEMU provides a framebuffer interface that makes standard + <listitem><para>QEMU provides a framebuffer interface that makes standard consoles available.</para></listitem> <listitem><para>Generally, headless embedded devices have a serial port. If so, you can configure the operating system of the running image - to use that port to run a console. + to use that port to run a console. The connection uses standard IP networking.</para></listitem> <listitem><para>SSH servers exist in some QEMU images. - The <filename>core-image-sato</filename> QEMU image has a Dropbear secure + The <filename>core-image-sato</filename> QEMU image has a Dropbear secure shell (ssh) server that runs with the root password disabled. - The <filename>core-image-basic</filename> and <filename>core-image-lsb</filename> QEMU images + The <filename>core-image-basic</filename> and <filename>core-image-lsb</filename> QEMU images have OpenSSH instead of Dropbear. - Including these SSH servers allow you to use standard <filename>ssh</filename> and + Including these SSH servers allow you to use standard <filename>ssh</filename> and <filename>scp</filename> commands. - The <filename>core-image-minimal</filename> QEMU image, however, contains no ssh + The <filename>core-image-minimal</filename> QEMU image, however, contains no ssh server.</para></listitem> - <listitem><para>You can use a provided, user-space NFS server to boot the QEMU session + <listitem><para>You can use a provided, user-space NFS server to boot the QEMU session using a local copy of the root filesystem on the host. - In order to make this connection, you must extract a root filesystem tarball by using the + In order to make this connection, you must extract a root filesystem tarball by using the <filename>runqemu-extract-sdk</filename> command. After running the command, you must then point the <filename>runqemu</filename> script to the extracted directory instead of a root filesystem image file.</para></listitem> diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml index 19503a928f..5eea2e22aa 100644 --- a/documentation/dev-manual/dev-manual.xml +++ b/documentation/dev-manual/dev-manual.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > -<book id='dev-manual' lang='en' +<book id='dev-manual' 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/dev-title.png' - format='SVG' + <imagedata fileref='figures/dev-title.png' + format='SVG' align='left' scalefit='1' width='100%'/> - </imageobject> + </imageobject> </mediaobject> - <title></title> + <title></title> <authorgroup> <author> @@ -58,9 +58,9 @@ <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-sa/2.0/uk/"> - Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by + Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by Creative Commons. </para> @@ -86,6 +86,6 @@ <xi:include href="dev-manual-common-tasks.xml"/> </book> -<!-- -vim: expandtab tw=80 ts=4 +<!-- +vim: expandtab tw=80 ts=4 --> |