sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

documentation: poky-ref-manual - Final changes before the 1.3 lockdown. 

various changes as required.

(From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2012-10-22 14:16:22 -07:00 committed by Richard Purdie
parent 2b51188de6
commit a73fde8caf
8 changed files with 90 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/poky-ref-manual/introduction.xml
View File

@ -306,7 +306,7 @@
<title>Development Checkouts</title> <title>Development Checkouts</title>
<para> <para>
Development using the Yocto Project requires a local Development using the Yocto Project requires a local
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
You can set up the source directory by downloading a Yocto Project release tarball and unpacking it, You can set up the source directory by downloading a Yocto Project release tarball and unpacking it,
or by cloning a copy of the upstream or by cloning a copy of the upstream
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.

2
documentation/poky-ref-manual/ref-bitbake.xml
View File

@ -36,7 +36,7 @@
<para> <para>
The first thing BitBake does is look for the <filename>bitbake.conf</filename> file. The first thing BitBake does is look for the <filename>bitbake.conf</filename> file.
This file resides in the This file resides in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
within the <filename>meta/conf/</filename> directory. within the <filename>meta/conf/</filename> directory.
BitBake finds it by examining its BitBake finds it by examining its
<link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment <link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment

10
documentation/poky-ref-manual/ref-classes.xml
View File

@ -13,7 +13,7 @@
Class files are identified by the extension <filename>.bbclass</filename> and are usually placed Class files are identified by the extension <filename>.bbclass</filename> and are usually placed
in a <filename>classes/</filename> directory beneath the in a <filename>classes/</filename> directory beneath the
<filename>meta*/</filename> directory found in the <filename>meta*/</filename> directory found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
Class files can also be pointed to by BUILDDIR (e.g. <filename>build/</filename>)in the same way as Class files can also be pointed to by BUILDDIR (e.g. <filename>build/</filename>)in the same way as
<filename>.conf</filename> files in the <filename>conf</filename> directory. <filename>.conf</filename> files in the <filename>conf</filename> directory.
Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link> Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
@ -302,7 +302,7 @@
<filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
variable defined in the <filename>local.conf</filename> configuration file, variable defined in the <filename>local.conf</filename> configuration file,
which is located in the <filename>conf</filename> folder of the which is located in the <filename>conf</filename> folder of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
When defining the variable, you can specify one or more package types. When defining the variable, you can specify one or more package types.
Since images are generated from packages, a packaging class is Since images are generated from packages, a packaging class is
needed to enable image generation. needed to enable image generation.
@ -538,7 +538,7 @@
you can use this class to specify those packages and associate the users and groups you can use this class to specify those packages and associate the users and groups
with those packages. with those packages.
The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename>
recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
provides a simple exmample that shows how to add three provides a simple exmample that shows how to add three
users and groups to two packages. users and groups to two packages.
See the <filename>useradd-example.bb</filename> for more information on how to See the <filename>useradd-example.bb</filename> for more information on how to
@ -568,7 +568,7 @@
<link linkend='var-B'><filename>B</filename></link> variable to point to the directory in <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in
which the OpenEmbedded build system places the generated objects built from the recipes. which the OpenEmbedded build system places the generated objects built from the recipes.
By default, the <filename>B</filename> directory is set to the following, which is separate from the By default, the <filename>B</filename> directory is set to the following, which is separate from the
source directory (<filename>S</filename>): Source Directory (<filename>S</filename>):
<literallayout class='monospaced'> <literallayout class='monospaced'>
${WORKDIR}/${BPN}-{PV}/ ${WORKDIR}/${BPN}-{PV}/
</literallayout> </literallayout>
@ -616,7 +616,7 @@
Thus far, this chapter has discussed only the most useful and important Thus far, this chapter has discussed only the most useful and important
classes. classes.
However, other classes exist within the <filename>meta/classes</filename> directory However, other classes exist within the <filename>meta/classes</filename> directory
in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
You can examine the <filename>.bbclass</filename> files directly for more You can examine the <filename>.bbclass</filename> files directly for more
information. information.
</para> </para>

4
documentation/poky-ref-manual/ref-features.xml
View File

@ -223,7 +223,7 @@
You can disable the feature without affecting You can disable the feature without affecting
other existing distro configurations that need PulseAudio support other existing distro configurations that need PulseAudio support
by adding "pulseaudio" to by adding "pulseaudio" to
DISTRO_FEATURES_BACKFILL_CONSIDERED <filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename>
in your distro's <filename>.conf</filename> file. in your distro's <filename>.conf</filename> file.
Adding the feature to this variable when it also Adding the feature to this variable when it also
exists in the <filename>DISTRO_FEATURES_BACKFILL</filename> exists in the <filename>DISTRO_FEATURES_BACKFILL</filename>
@ -240,7 +240,7 @@
You can disable RTC support for your device without You can disable RTC support for your device without
affecting other machines that need RTC support affecting other machines that need RTC support
by adding the feature to your machine's by adding the feature to your machine's
MACHINE_FEATURES_BACKFILL_CONSIDERED <filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename>
list in the machine's <filename>.conf</filename> file. list in the machine's <filename>.conf</filename> file.
Adding the feature to this variable when it also Adding the feature to this variable when it also
exists in the <filename>MACHINE_FEATURES_BACKFILL</filename> exists in the <filename>MACHINE_FEATURES_BACKFILL</filename>

38
documentation/poky-ref-manual/ref-structure.xml
View File

@ -7,14 +7,14 @@
<title>Source Directory Structure</title> <title>Source Directory Structure</title>
<para> <para>
The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> consists of several components. The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components.
Understanding them and knowing where they are located is key to using the Yocto Project well. Understanding them and knowing where they are located is key to using the Yocto Project well.
This chapter describes the source directory and gives information about the various This chapter describes the Source Directory and gives information about the various
files and directories. files and directories.
</para> </para>
<para> <para>
For information on how to establish a local source directory on your development system, see the For information on how to establish a local Source Directory on your development system, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
section in the Yocto Project Development Manual. section in the Yocto Project Development Manual.
</para> </para>
@ -26,7 +26,7 @@
<title><filename>bitbake/</filename></title> <title><filename>bitbake/</filename></title>
<para> <para>
The <ulink url='source-directory'>source directory</ulink> The <ulink url='source-directory'>Source Directory</ulink>
includes a copy of BitBake for ease of use. includes a copy of BitBake for ease of use.
The copy usually matches the current stable BitBake release from the BitBake project. The copy usually matches the current stable BitBake release from the BitBake project.
BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks
@ -39,7 +39,7 @@
When you run the <filename>bitbake</filename> command, the wrapper script in When you run the <filename>bitbake</filename> command, the wrapper script in
<filename>scripts/</filename> is executed to run the main BitBake executable, <filename>scripts/</filename> is executed to run the main BitBake executable,
which resides in the <filename>bitbake/bin/</filename> directory. which resides in the <filename>bitbake/bin/</filename> directory.
Sourcing the <link linkend="structure-core-script">oe-init-build-env</link> Sourcing the <link linkend="structure-core-script">&OE_INIT_FILE;</link>
script places the <filename>scripts</filename> and <filename>bitbake/bin</filename> script places the <filename>scripts</filename> and <filename>bitbake/bin</filename>
directories (in that order) into the shell's <filename>PATH</filename> environment directories (in that order) into the shell's <filename>PATH</filename> environment
variable. variable.
@ -59,19 +59,19 @@
This directory contains user configuration files and the output This directory contains user configuration files and the output
generated by the OpenEmbedded build system in its standard configuration where generated by the OpenEmbedded build system in its standard configuration where
the source tree is combined with the output. the source tree is combined with the output.
The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
is created initially when you <filename>source</filename> is created initially when you <filename>source</filename>
the OpenEmbedded build environment setup script <filename>oe-init-build-env</filename>. the OpenEmbedded build environment setup script <filename>&OE_INIT_FILE;</filename>.
</para> </para>
<para> <para>
It is also possible to place output and configuration It is also possible to place output and configuration
files in a directory separate from the files in a directory separate from the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
by providing a directory name when you <filename>source</filename> by providing a directory name when you <filename>source</filename>
the setup script. the setup script.
For information on separating output from your local source directory files, see <link For information on separating output from your local Source Directory files, see <link
linkend='structure-core-script'>oe-init-build-env</link>. linkend='structure-core-script'>&OE_INIT_FILE;</link>.
</para> </para>
</section> </section>
@ -141,7 +141,7 @@
<para> <para>
This directory contains various integration scripts that implement This directory contains various integration scripts that implement
extra functionality in the Yocto Project environment (e.g. QEMU scripts). extra functionality in the Yocto Project environment (e.g. QEMU scripts).
The <link linkend="structure-core-script">oe-init-build-env</link> script appends this The <link linkend="structure-core-script">&OE_INIT_FILE;</link> script appends this
directory to the shell's <filename>PATH</filename> environment variable. directory to the shell's <filename>PATH</filename> environment variable.
</para> </para>
@ -153,7 +153,7 @@
</section> </section>
<section id='structure-core-script'> <section id='structure-core-script'>
<title><filename>oe-init-build-env</filename></title> <title><filename>&OE_INIT_FILE;</filename></title>
<para> <para>
This script sets up the OpenEmbedded build environment. This script sets up the OpenEmbedded build environment.
@ -166,16 +166,16 @@
</para> </para>
<para> <para>
By default, running this script without a build directory argument creates the By default, running this script without a Build Directory argument creates the
<filename>build</filename> directory. <filename>build</filename> directory.
If you provide a build directory argument when you <filename>source</filename> If you provide a Build Directory argument when you <filename>source</filename>
the script, you direct OpenEmbedded build system to create a the script, you direct OpenEmbedded build system to create a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> of your choice. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> of your choice.
For example, the following command creates a build directory named For example, the following command creates a Build Directory named
<filename>mybuilds</filename> that is outside of the <filename>mybuilds</filename> that is outside of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ source oe-init-build-env ~/mybuilds $ source &OE_INIT_FILE; ~/mybuilds
</literallayout> </literallayout>
</para> </para>
</section> </section>
@ -387,7 +387,7 @@
data. data.
Packages that need to share output with other packages do so within this directory. Packages that need to share output with other packages do so within this directory.
The directory is subdivided by architecture so multiple builds can run within The directory is subdivided by architecture so multiple builds can run within
the one build directory. the one Build Directory.
</para> </para>
</section> </section>

87
documentation/poky-ref-manual/ref-variables.xml
View File

@ -93,8 +93,8 @@
<glossentry id='var-B'><glossterm>B</glossterm> <glossentry id='var-B'><glossterm>B</glossterm>
<glossdef> <glossdef>
<para> <para>
The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
The OpenEmbedded build system places generated objects into the build directory The OpenEmbedded build system places generated objects into the Build Directory
during a recipe's build process. during a recipe's build process.
By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
directory: directory:
@ -165,7 +165,7 @@
</literallayout></para> </literallayout></para>
<para>Use the <filename>BBMASK</filename> variable from within the <para>Use the <filename>BBMASK</filename> variable from within the
<filename>conf/local.conf</filename> file found <filename>conf/local.conf</filename> file found
in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.</para> in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -250,7 +250,7 @@
<glossdef> <glossdef>
<para>Lists the layers to enable during the build. <para>Lists the layers to enable during the build.
This variable is defined in the <filename>bblayers.conf</filename> configuration This variable is defined in the <filename>bblayers.conf</filename> configuration
file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
Here is an example: Here is an example:
<literallayout class='monospaced'> <literallayout class='monospaced'>
BBLAYERS = " \ BBLAYERS = " \
@ -362,7 +362,7 @@
than <filename>/usr/bin</filename>. than <filename>/usr/bin</filename>.
You can find a list of these variables at the top of the You can find a list of these variables at the top of the
<filename>/meta/conf/bitbake.conf</filename> file in the <filename>/meta/conf/bitbake.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</note> </note>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -384,7 +384,7 @@
Specifies the list of packages to be added to the image. Specifies the list of packages to be added to the image.
This variable should only be set in the <filename>local.conf</filename> This variable should only be set in 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>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
</para> </para>
<para> <para>
@ -581,7 +581,7 @@
This directory is self-maintaining and you should not have This directory is self-maintaining and you should not have
to touch it. to touch it.
By default, the directory is <filename>downloads</filename> in the By default, the directory is <filename>downloads</filename> in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<literallayout class='monospaced'> <literallayout class='monospaced'>
#DL_DIR ?= "${TOPDIR}/downloads" #DL_DIR ?= "${TOPDIR}/downloads"
</literallayout> </literallayout>
@ -755,7 +755,7 @@
than <filename>/usr/bin</filename>. than <filename>/usr/bin</filename>.
You can find a list of these variables at the top of the You can find a list of these variables at the top of the
<filename>/meta/conf/bitbake.conf</filename> file in the <filename>/meta/conf/bitbake.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</note> </note>
<para> <para>
@ -821,7 +821,7 @@
The default value for the <filename>FILESPATH</filename> variable is defined The default value for the <filename>FILESPATH</filename> variable is defined
in the <filename>base.bbclass</filename> class found in in the <filename>base.bbclass</filename> class found in
<filename>meta/classes</filename> in the <filename>meta/classes</filename> in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
"${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \
@ -848,14 +848,14 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
<para> <para>
By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which
is located in the <filename>meta/files</filename> folder in the is located in the <filename>meta/files</filename> folder in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
If you create your own file permissions setting table, you should place it in your If you create your own file permissions setting table, you should place it in your
layer or the distros layer. layer or the distros layer.
</para> </para>
<para> <para>
You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
<filename>conf/local.conf</filename> file, which is found in the <filename>conf/local.conf</filename> file, which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, to <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to
point to your custom <filename>fs-perms.txt</filename>. point to your custom <filename>fs-perms.txt</filename>.
You can specify more than a single file permissions setting table. You can specify more than a single file permissions setting table.
The paths you specify to these files must be defined within the The paths you specify to these files must be defined within the
@ -1200,20 +1200,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Values for this variable are set in the kernel's recipe file and the kernel's Values for this variable are set in the kernel's recipe file and the kernel's
append file. append file.
For example, if you are using the Yocto Project kernel that is based on the For example, if you are using the Yocto Project kernel that is based on the
Linux 3.2 kernel, the kernel recipe file is the Linux 3.4 kernel, the kernel recipe file is the
<filename>meta/recipes-kernel/linux/linux-yocto_3.2.bb</filename> file. <filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file.
Following is the default value for <filename>KBRANCH</filename> and the five overrides Following is the default value for <filename>KBRANCH</filename> and the default
for the architectures the Yocto Project supports: override for the architectures the Yocto Project supports:
<literallayout class='monospaced'> <literallayout class='monospaced'>
KBRANCH = "standard/default/base" KBRANCH_DEFAULT = "standard/base"
KBRANCH_qemux86 = "standard/default/common-pc/base" KBRANCH = "${KBRANCH_DEFAULT}"
KBRANCH_qemux86-64 = "standard/default/common-pc-64/base"
KBRANCH_qemuppc = "standard/default/qemu-ppc32"
KBRANCH_qemumips = "standard/default/mti-malta32-be"
KBRANCH_qemuarm = "standard/default/arm-versatile-926ejs"
</literallayout> </literallayout>
Each of the above branches exist in the <filename>linux-yocto-3.2</filename> kernel Git This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git
repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.2/refs/heads'></ulink>. repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
</para> </para>
<para> <para>
@ -1222,16 +1218,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The kernel's append file is located in the BSP layer for a given machine. The kernel's append file is located in the BSP layer for a given machine.
For example, the kernel append file for the Crown Bay BSP is in the For example, the kernel append file for the Crown Bay BSP is in the
<filename>meta-intel</filename> Git repository and is named <filename>meta-intel</filename> Git repository and is named
<filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend</filename>. <filename>meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend</filename>.
Here are the related statements from the append file: Here are the related statements from the append file:
<literallayout class='monospaced'> <literallayout class='monospaced'>
COMPATIBLE_MACHINE_crownbay = "crownbay" COMPATIBLE_MACHINE_crownbay = "crownbay"
KMACHINE_crownbay = "crownbay" KMACHINE_crownbay = "crownbay"
KBRANCH_crownbay = "standard/default/crownbay" KBRANCH_crownbay = "standard/crownbay"
COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
KMACHINE_crownbay-noemgd = "crownbay" KMACHINE_crownbay-noemgd = "crownbay"
KBRANCH_crownbay-noemgd = "standard/default/crownbay" KBRANCH_crownbay-noemgd = "standard/crownbay"
</literallayout> </literallayout>
The <filename>KBRANCH_*</filename> statements identify the kernel branch to The <filename>KBRANCH_*</filename> statements identify the kernel branch to
use when building for the Crown Bay BSP. use when building for the Crown Bay BSP.
@ -1294,10 +1290,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para> <para>
Kernel machine names are initially defined in the Kernel machine names are initially defined in the
<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink> in <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Yocto Linux Kernel</ulink> in
the <filename>meta</filename> branch.
From the <filename>meta</filename> branch, look in
the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file. the <filename>meta/cfg/kernel-cache/bsp/&lt;bsp_name&gt;/&lt;bsp-name&gt;-&lt;kernel-type&gt;.scc</filename> file.
For example, in the <filename>linux-yocto-3.4</filename> kernel in the For example, from the <filename>meta</filename> branch in the
<filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file, <filename>linux-yocto-3.0</filename> kernel, the
<filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file
has the following: has the following:
<literallayout class='monospaced'> <literallayout class='monospaced'>
define KMACHINE cedartrail define KMACHINE cedartrail
@ -1307,7 +1306,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
include ktypes/standard include ktypes/standard
branch cedartrail branch cedartrail
include cedartrail.scc include cedartrail.scc
</literallayout> </literallayout>
You can see that the kernel understands the machine name for the Cedar Trail BSP as You can see that the kernel understands the machine name for the Cedar Trail BSP as
<filename>cedartrail</filename>. <filename>cedartrail</filename>.
@ -1795,7 +1794,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossdef> <glossdef>
<para>This variable, which is set in the <filename>local.conf</filename> configuration <para>This variable, which is set in the <filename>local.conf</filename> configuration
file found in the <filename>conf</filename> folder of the file found in the <filename>conf</filename> folder of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>, <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
specifies the package manager to use when packaging data. specifies the package manager to use when packaging data.
You can provide one or more arguments for the variable with the first You can provide one or more arguments for the variable with the first
argument being the package manager used to create images: argument being the package manager used to create images:
@ -2134,7 +2133,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-S'><glossterm>S</glossterm> <glossentry id='var-S'><glossterm>S</glossterm>
<glossdef> <glossdef>
<para> <para>
The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
where unpacked package source code resides. where unpacked package source code resides.
This location is within the working directory This location is within the working directory
(<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which (<filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>), which
@ -2147,9 +2146,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
${WORKDIR}/${PN}-${PV} ${WORKDIR}/${PN}-${PV}
</literallayout> </literallayout>
As an example, assume a As an example, assume a
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
folder named <filename>poky</filename> folder named <filename>poky</filename>
and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> and a default <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
at <filename>poky/build</filename>. at <filename>poky/build</filename>.
In this case, the working directory the build system uses to build In this case, the working directory the build system uses to build
the <filename>db</filename> package is the following: the <filename>db</filename> package is the following:
@ -2578,7 +2577,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
the upstream GCC or CodeSourcery Labs toolchain. the upstream GCC or CodeSourcery Labs toolchain.
The variable identifies the <filename>tcmode-*</filename> files used in The variable identifies the <filename>tcmode-*</filename> files used in
the <filename>meta/conf/distro/include</filename> directory, which is found in the the <filename>meta/conf/distro/include</filename> directory, which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para> </para>
<para> <para>
By default, <filename>TCMODE</filename> is set to "default", which By default, <filename>TCMODE</filename> is set to "default", which
@ -2598,14 +2597,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
uses when it does its work building images. uses when it does its work building images.
By default, the <filename>TMPDIR</filename> variable is named By default, the <filename>TMPDIR</filename> variable is named
<filename>tmp</filename> within the <filename>tmp</filename> within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
</para> </para>
<para> <para>
If you want to establish this directory in a location other than the If you want to establish this directory in a location other than the
default, you can uncomment the following statement in the default, you can uncomment the following statement in the
<filename>conf/local.conf</filename> file in the <filename>conf/local.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>: <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>:
<literallayout class='monospaced'> <literallayout class='monospaced'>
#TMPDIR = "${TOPDIR}/tmp" #TMPDIR = "${TOPDIR}/tmp"
</literallayout> </literallayout>
@ -2617,9 +2616,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossdef> <glossdef>
<para> <para>
This variable is the This variable is the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
BitBake automatically sets this variable. BitBake automatically sets this variable.
The OpenEmbedded build system uses the build directory when building images. The OpenEmbedded build system uses the Build Directory when building images.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -2664,9 +2663,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
</literallayout> </literallayout>
As an example, assume a As an example, assume a
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> top-level <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> top-level
folder name <filename>poky</filename> and a default folder name <filename>poky</filename> and a default
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
at <filename>poky/build</filename>. at <filename>poky/build</filename>.
In this case, the working directory the build system uses to build In this case, the working directory the build system uses to build
the <filename>v86d</filename> package is the following: the <filename>v86d</filename> package is the following:
@ -2681,8 +2680,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<literallayout class='monospaced'> <literallayout class='monospaced'>
${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
</literallayout> </literallayout>
As an example, again assume a source directory top-level folder As an example, again assume a Source Directory top-level folder
named <filename>poky</filename> and a default build directory named <filename>poky</filename> and a default Build Directory
at <filename>poky/build</filename>. at <filename>poky/build</filename>.
In this case, the working directory the build system uses to build In this case, the working directory the build system uses to build
the <filename>acl</filename> recipe, which is being built for a the <filename>acl</filename> recipe, which is being built for a

15
documentation/poky-ref-manual/technical-details.xml
View File

@ -129,7 +129,7 @@
between metadata files. between metadata files.
An example is the Autotools class, which contains An example is the Autotools class, which contains
common settings for any application that Autotools uses. common settings for any application that Autotools uses.
The "<link linkend='ref-classes'>Reference: Classes</link>" chapter provides details The "<link linkend='ref-classes'>Classes</link>" chapter provides details
about common classes and how to use them. about common classes and how to use them.
</para> </para>
</section> </section>
@ -143,7 +143,7 @@
These files fall into several areas that define machine configuration options, These files fall into several areas that define machine configuration options,
distribution configuration options, compiler tuning options, general common configuration distribution configuration options, compiler tuning options, general common configuration
options and user configuration options (<filename>local.conf</filename>, which is found options and user configuration options (<filename>local.conf</filename>, which is found
in the <ulink url='build-directory'>build directory</ulink>). in the <ulink url='build-directory'>Build Directory</ulink>).
</para> </para>
</section> </section>
</section> </section>
@ -304,7 +304,7 @@
Information based on direct inputs is referred to as the "basehash" in the Information based on direct inputs is referred to as the "basehash" in the
code. code.
However, there is still the question of a task's indirect inputs - the However, there is still the question of a task's indirect inputs - the
things that were already built and present in the build directory. things that were already built and present in the Build Directory.
The checksum (or signature) for a particular task needs to add the hashes The checksum (or signature) for a particular task needs to add the hashes
of all the tasks on which the particular task depends. of all the tasks on which the particular task depends.
Choosing which dependencies to add is a policy decision. Choosing which dependencies to add is a policy decision.
@ -650,7 +650,7 @@
Yocto Project, you can follow these steps to use the x32 spABI: Yocto Project, you can follow these steps to use the x32 spABI:
<itemizedlist> <itemizedlist>
<listitem><para>Add the <filename>experimental/meta-x32</filename> layer to your local <listitem><para>Add the <filename>experimental/meta-x32</filename> layer to your local
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
You can find the <filename>experimental/meta-x32</filename> source repository at You can find the <filename>experimental/meta-x32</filename> source repository at
<ulink url='&YOCTO_GIT_URL;'></ulink>.</para></listitem> <ulink url='&YOCTO_GIT_URL;'></ulink>.</para></listitem>
<listitem><para>Edit your <filename>conf/bblayers.conf</filename> file so that it includes <listitem><para>Edit your <filename>conf/bblayers.conf</filename> file so that it includes
@ -698,6 +698,13 @@
which by default are disabled. which by default are disabled.
</para> </para>
<para>
For information that can help you maintain compliance with various open
source licensing during the lifecycle of the product, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Project's Lifecycle</ulink>" section
in the Yocto Project Development Manual.
</para>
<section id="usingpoky-configuring-LIC_FILES_CHKSUM"> <section id="usingpoky-configuring-LIC_FILES_CHKSUM">
<title>Tracking License Changes</title> <title>Tracking License Changes</title>

16
documentation/poky-ref-manual/usingpoky.xml
View File

@ -30,20 +30,20 @@
The first thing you need to do is set up the OpenEmbedded build environment by sourcing The first thing you need to do is set up the OpenEmbedded build environment by sourcing
the environment setup script as follows: the environment setup script as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ source oe-init-build-env [build_dir] $ source &OE_INIT_FILE; [build_dir]
</literallayout> </literallayout>
</para> </para>
<para> <para>
The <filename>build_dir</filename> is optional and specifies the directory the The <filename>build_dir</filename> is optional and specifies the directory the
OpenEmbedded build system uses for the build - OpenEmbedded build system uses for the build -
the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
If you do not specify a build directory it defaults to <filename>build</filename> If you do not specify a Build Directory it defaults to <filename>build</filename>
in your current working directory. in your current working directory.
A common practice is to use a different build directory for different targets. A common practice is to use a different Build Directory for different targets.
For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target. target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target.
See <link linkend="structure-core-script">oe-init-build-env</link> See <link linkend="structure-core-script">&OE_INIT_FILE;</link>
for more information on this script. for more information on this script.
</para> </para>
@ -58,7 +58,7 @@
The <filename>target</filename> is the name of the recipe you want to build. The <filename>target</filename> is the name of the recipe you want to build.
Common targets are the images in <filename>meta/recipes-core/images</filename>, Common targets are the images in <filename>meta/recipes-core/images</filename>,
<filename>/meta/recipes-sato/images</filename>, etc. all found in the <filename>/meta/recipes-sato/images</filename>, etc. all found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
Or, the target can be the name of a recipe for a specific piece of software such as Or, the target can be the name of a recipe for a specific piece of software such as
<application>busybox</application>. <application>busybox</application>.
For more details about the images the OpenEmbedded build system supports, see the For more details about the images the OpenEmbedded build system supports, see the
@ -91,7 +91,7 @@
<para> <para>
Once an image has been built, it often needs to be installed. Once an image has been built, it often needs to be installed.
The images and kernels built by the OpenEmbedded build system are placed in the The images and kernels built by the OpenEmbedded build system are placed in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> in <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in
<filename class="directory">tmp/deploy/images</filename>. <filename class="directory">tmp/deploy/images</filename>.
For information on how to run pre-built images such as <filename>qemux86</filename> For information on how to run pre-built images such as <filename>qemux86</filename>
and <filename>qemuarm</filename>, see the and <filename>qemuarm</filename>, see the
@ -268,7 +268,7 @@
For guidance on how logging is handled in both Python and Bash recipes, see the For guidance on how logging is handled in both Python and Bash recipes, see the
<filename>logging.bbclass</filename> file in the <filename>logging.bbclass</filename> file in the
<filename>meta/classes</filename> folder of the <filename>meta/classes</filename> folder of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para> </para>
<section id='logging-with-python'> <section id='logging-with-python'>