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

dev-manual: Edits to "Running a Build on the Recipe" 

Corrective edits to this section based on Paul's feedback.  Several
items addressed.

(From yocto-docs rev: a09ebe38e0ad22ad4ab12eab3d5a73166e4c56f8)

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 2014-01-08 09:28:59 -06:00 committed by Richard Purdie
parent 0e03166f26
commit 32d69605c6
1 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -1317,46 +1317,45 @@
<title>Running a Build on the Recipe</title>
<para>
Creating a new recipe is an iterative process that requires
using BitBake to process the recipe multiple times in order to
progressively discover and add information to the recipe.
Creating a new recipe is usually an iterative process that
requires using BitBake to process the recipe multiple times in
order to progressively discover and add information to the
recipe.
</para>
<para>
To process the recipe, use the following BitBake command form
from within the
<link linkend='build-directory'>Build Directory</link>:
<literallayout class='monospaced'>
$ bitbake &lt;base-recipe-name&gt;
</literallayout>
Before you run BitBake, be sure that you source a build
environment setup script (i.e.
Assuming you have sourced a build environment setup script (i.e.
<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
or
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>.
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
and you are in the
<link linkend='build-directory'>Build Directory</link>,
use BitBake to process your recipe.
All you need to provide is the base name of your recipe:
<literallayout class='monospaced'>
$ bitbake &lt;basename&gt;
</literallayout>
</para>
<para>
The OpenEmbedded build system creates a temporary work
directory
During the build, the OpenEmbedded build system creates a
temporary work directory for the recipe
(<filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename>)
where it keeps extracted source files, log files, images, and
so forth.
You can find individual logs in this area for each task.
</para>
<para>
This temporary work directory is constructed depending on
several factors.
For packages that are not dependent on a particular machine,
<filename>WORKDIR</filename> is defined as follows:
The temporary work directory is constructed as follows and
depends on several factors:
<literallayout class='monospaced'>
${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR}
${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
</literallayout>
As an example, assume a Source Directory top-level folder name
<filename>poky</filename>, a default Build Directory at
<filename>poky/build</filename>, a <filename>qemux86</filename>
package architecture, and a <filename>linux</filename> target
operating system.
<filename>poky/build</filename>, and a
<filename>qemux86-poky-linux</filename> machine target system.
Furthermore, suppose your recipe is named
<filename>foo_1.3.0-r0.bb</filename>.
In this case, the work directory the build system uses to
@ -1365,7 +1364,7 @@
poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
</literallayout>
Inside this directory you can find sub-directories such as
<filename>image</filename>, <filename>package-split</filename>,
<filename>image</filename>, <filename>packages-split</filename>,
and <filename>temp</filename>.
After the build, you can examine these to determine how well
the build went.
@ -1382,9 +1381,9 @@
Yocto Project Reference Manual's glossary for more information:
<itemizedlist>
<listitem>The temporary directory - <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink></listitem>
<listitem>The package architecture - <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink></listitem>
<listitem>The target operating system - <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink></listitem>
<listitem>The machine architecture - <ulink url='&YOCTO_DOCS_REF_URL;#var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></ulink></listitem>
<listitem>The recipe name - <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink></listitem>
<listitem>The epoch - <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTENDPE'><filename>EXTENDPE</filename></ulink></listitem>
<listitem>The recipe version - <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink></listitem>
<listitem>The recipe revision - <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink></listitem>
</itemizedlist>