summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-01-08 09:28:59 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-21 21:57:57 +0000
commit32d69605c6525a4dcfbda2a81a736229223d0d78 (patch)
tree6488e3873316b8fbcfe0e94b0205a60f8cd95ac7 /documentation/dev-manual
parent0e03166f2668553d1fd9f108e17c2167ac33d19f (diff)
downloadpoky-32d69605c6525a4dcfbda2a81a736229223d0d78.tar.gz
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>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml49
1 files changed, 24 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 06555c3c51..28ff9c08e9 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1317,46 +1317,45 @@
1317 <title>Running a Build on the Recipe</title> 1317 <title>Running a Build on the Recipe</title>
1318 1318
1319 <para> 1319 <para>
1320 Creating a new recipe is an iterative process that requires 1320 Creating a new recipe is usually an iterative process that
1321 using BitBake to process the recipe multiple times in order to 1321 requires using BitBake to process the recipe multiple times in
1322 progressively discover and add information to the recipe. 1322 order to progressively discover and add information to the
1323 recipe.
1323 </para> 1324 </para>
1324 1325
1325 <para> 1326 <para>
1326 To process the recipe, use the following BitBake command form 1327 Assuming you have sourced a build environment setup script (i.e.
1327 from within the
1328 <link linkend='build-directory'>Build Directory</link>:
1329 <literallayout class='monospaced'>
1330 $ bitbake &lt;base-recipe-name&gt;
1331 </literallayout>
1332 Before you run BitBake, be sure that you source a build
1333 environment setup script (i.e.
1334 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 1328 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
1335 or 1329 or
1336 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>. 1330 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
1331 and you are in the
1332 <link linkend='build-directory'>Build Directory</link>,
1333 use BitBake to process your recipe.
1334 All you need to provide is the base name of your recipe:
1335 <literallayout class='monospaced'>
1336 $ bitbake &lt;basename&gt;
1337 </literallayout>
1337 </para> 1338 </para>
1338 1339
1339 <para> 1340 <para>
1340 The OpenEmbedded build system creates a temporary work 1341 During the build, the OpenEmbedded build system creates a
1341 directory 1342 temporary work directory for the recipe
1342 (<filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename>) 1343 (<filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename>)
1343 where it keeps extracted source files, log files, images, and 1344 where it keeps extracted source files, log files, images, and
1344 so forth. 1345 so forth.
1346 You can find individual logs in this area for each task.
1345 </para> 1347 </para>
1346 1348
1347 <para> 1349 <para>
1348 This temporary work directory is constructed depending on 1350 The temporary work directory is constructed as follows and
1349 several factors. 1351 depends on several factors:
1350 For packages that are not dependent on a particular machine,
1351 <filename>WORKDIR</filename> is defined as follows:
1352 <literallayout class='monospaced'> 1352 <literallayout class='monospaced'>
1353 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR} 1353 ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}
1354 </literallayout> 1354 </literallayout>
1355 As an example, assume a Source Directory top-level folder name 1355 As an example, assume a Source Directory top-level folder name
1356 <filename>poky</filename>, a default Build Directory at 1356 <filename>poky</filename>, a default Build Directory at
1357 <filename>poky/build</filename>, a <filename>qemux86</filename> 1357 <filename>poky/build</filename>, and a
1358 package architecture, and a <filename>linux</filename> target 1358 <filename>qemux86-poky-linux</filename> machine target system.
1359 operating system.
1360 Furthermore, suppose your recipe is named 1359 Furthermore, suppose your recipe is named
1361 <filename>foo_1.3.0-r0.bb</filename>. 1360 <filename>foo_1.3.0-r0.bb</filename>.
1362 In this case, the work directory the build system uses to 1361 In this case, the work directory the build system uses to
@@ -1365,7 +1364,7 @@
1365 poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 1364 poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
1366 </literallayout> 1365 </literallayout>
1367 Inside this directory you can find sub-directories such as 1366 Inside this directory you can find sub-directories such as
1368 <filename>image</filename>, <filename>package-split</filename>, 1367 <filename>image</filename>, <filename>packages-split</filename>,
1369 and <filename>temp</filename>. 1368 and <filename>temp</filename>.
1370 After the build, you can examine these to determine how well 1369 After the build, you can examine these to determine how well
1371 the build went. 1370 the build went.
@@ -1382,9 +1381,9 @@
1382 Yocto Project Reference Manual's glossary for more information: 1381 Yocto Project Reference Manual's glossary for more information:
1383 <itemizedlist> 1382 <itemizedlist>
1384 <listitem>The temporary directory - <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink></listitem> 1383 <listitem>The temporary directory - <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink></listitem>
1385 <listitem>The package architecture - <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink></listitem> 1384 <listitem>The machine architecture - <ulink url='&YOCTO_DOCS_REF_URL;#var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></ulink></listitem>
1386 <listitem>The target operating system - <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink></listitem>
1387 <listitem>The recipe name - <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink></listitem> 1385 <listitem>The recipe name - <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink></listitem>
1386 <listitem>The epoch - <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTENDPE'><filename>EXTENDPE</filename></ulink></listitem>
1388 <listitem>The recipe version - <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink></listitem> 1387 <listitem>The recipe version - <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink></listitem>
1389 <listitem>The recipe revision - <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink></listitem> 1388 <listitem>The recipe revision - <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink></listitem>
1390 </itemizedlist> 1389 </itemizedlist>