mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-07-17 04:07:06 +00:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
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 be3c73bc02
commit f735e50c63
8 changed files with 90 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/poky-ref-manual/ref-variables.xml
+43 -44
View File
@@ -93,8 +93,8 @@
<glossentry id='var-B'><glossterm>B</glossterm>
<glossdef>
<para>
The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
The OpenEmbedded build system places generated objects into the build directory
The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
The OpenEmbedded build system places generated objects into the Build Directory
during a recipe's build process.
By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
directory:
@@ -165,7 +165,7 @@
</literallayout></para>
<para>Use the <filename>BBMASK</filename> variable from within the
<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>
</glossentry>
@@ -250,7 +250,7 @@
<glossdef>
<para>Lists the layers to enable during the build.
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:
<literallayout class='monospaced'>
BBLAYERS = " \
@@ -362,7 +362,7 @@
than <filename>/usr/bin</filename>.
You can find a list of these variables at the top of 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>
</glossdef>
</glossentry>
@@ -384,7 +384,7 @@
Specifies the list of packages to be added to the image.
This variable should only be set in the <filename>local.conf</filename>
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>
@@ -581,7 +581,7 @@
This directory is self-maintaining and you should not have
to touch it.
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'>
#DL_DIR ?= "${TOPDIR}/downloads"
</literallayout>
@@ -755,7 +755,7 @@
than <filename>/usr/bin</filename>.
You can find a list of these variables at the top of 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>
<para>
@@ -821,7 +821,7 @@
The default value for the <filename>FILESPATH</filename> variable is defined
in the <filename>base.bbclass</filename> class found in
<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'>
FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
"${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \
@@ -848,14 +848,14 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
<para>
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
<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
layer or the distros layer.
</para>
<para>
You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable 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>.
You can specify more than a single file permissions setting table.
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
append file.
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
<filename>meta/recipes-kernel/linux/linux-yocto_3.2.bb</filename> file.
Following is the default value for <filename>KBRANCH</filename> and the five overrides
for the architectures the Yocto Project supports:
Linux 3.4 kernel, the kernel recipe file is the
<filename>meta/recipes-kernel/linux/linux-yocto_3.4.bb</filename> file.
Following is the default value for <filename>KBRANCH</filename> and the default
override for the architectures the Yocto Project supports:
<literallayout class='monospaced'>
KBRANCH = "standard/default/base"
KBRANCH_qemux86 = "standard/default/common-pc/base"
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"
KBRANCH_DEFAULT = "standard/base"
KBRANCH = "${KBRANCH_DEFAULT}"
</literallayout>
Each of the above branches exist in the <filename>linux-yocto-3.2</filename> kernel Git
repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.2/refs/heads'></ulink>.
This branch exists in the <filename>linux-yocto-3.4</filename> kernel Git
repository <ulink url='&YOCTO_GIT_URL;/cgit.cgi/linux-yocto-3.4/refs/heads'></ulink>.
</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.
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-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:
<literallayout class='monospaced'>
COMPATIBLE_MACHINE_crownbay = "crownbay"
KMACHINE_crownbay = "crownbay"
KBRANCH_crownbay = "standard/default/crownbay"
KBRANCH_crownbay = "standard/crownbay"
COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
KMACHINE_crownbay-noemgd = "crownbay"
KBRANCH_crownbay-noemgd = "standard/default/crownbay"
KBRANCH_crownbay-noemgd = "standard/crownbay"
</literallayout>
The <filename>KBRANCH_*</filename> statements identify the kernel branch to
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>
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.
For example, in the <filename>linux-yocto-3.4</filename> kernel in the
<filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file,
For example, from the <filename>meta</filename> branch in the
<filename>linux-yocto-3.0</filename> kernel, the
<filename>meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc</filename> file
has the following:
<literallayout class='monospaced'>
define KMACHINE cedartrail
@@ -1307,7 +1306,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
include ktypes/standard
branch cedartrail
include cedartrail.scc
include cedartrail.scc
</literallayout>
You can see that the kernel understands the machine name for the Cedar Trail BSP as
<filename>cedartrail</filename>.
@@ -1795,7 +1794,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossdef>
<para>This variable, which is set in the <filename>local.conf</filename> configuration
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.
You can provide one or more arguments for the variable with the first
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>
<glossdef>
<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.
This location is within the working directory
(<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}
</literallayout>
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>
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>.
In this case, the working directory the build system uses to build
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 variable identifies the <filename>tcmode-*</filename> files used in
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>
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.
By default, the <filename>TMPDIR</filename> variable is named
<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>
If you want to establish this directory in a location other than the
default, you can uncomment the following statement 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'>
#TMPDIR = "${TOPDIR}/tmp"
</literallayout>
@@ -2617,9 +2616,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossdef>
<para>
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.
The OpenEmbedded build system uses the build directory when building images.
The OpenEmbedded build system uses the Build Directory when building images.
</para>
</glossdef>
</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}
</literallayout>
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
<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>.
In this case, the working directory the build system uses to build
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'>
${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
</literallayout>
As an example, again assume a source directory top-level folder
named <filename>poky</filename> and a default build directory
As an example, again assume a Source Directory top-level folder
named <filename>poky</filename> and a default Build Directory
at <filename>poky/build</filename>.
In this case, the working directory the build system uses to build
the <filename>acl</filename> recipe, which is being built for a