summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-09-14 19:35:05 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-09-24 15:36:04 (GMT)
commit21ce4e481ee812aa17ba5a08b327d91fa241c4c5 (patch)
tree8e5ab52a165cb66f5a6d837435157e052d401cb3
parent88429f018bbb15749f31067d5e7bf33c21b15f92 (diff)
downloadpoky-21ce4e481ee812aa17ba5a08b327d91fa241c4c5.tar.gz
documentation: Build example in QS and poky.ent variable added
I changed the example that builds an image so that it uses the default build directory. It seems like the natural thing to do. Also added a new poky.ent variable named OE_INIT_FILE. This variable is set to the name of the build environment script (From yocto-docs rev: f0db49e27e89aefb6d43a0b455c6ecc529399c27) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky.ent1
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml14
2 files changed, 10 insertions, 5 deletions
diff --git a/documentation/poky.ent b/documentation/poky.ent
index 342865a..5aa4da8 100644
--- a/documentation/poky.ent
+++ b/documentation/poky.ent
@@ -47,3 +47,4 @@
47<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;"> 47<!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;">
48<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2"> 48<!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
49<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env"> 49<!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
50<!ENTITY OE_INIT_FILE "oe-init-build-env">
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index b37a45f..3fde5b7 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -387,7 +387,8 @@
387 <literallayout class='monospaced'> 387 <literallayout class='monospaced'>
388 $ wget &YOCTO_POKY_DL_URL; 388 $ wget &YOCTO_POKY_DL_URL;
389 $ tar xjf &YOCTO_POKY;.tar.bz2 389 $ tar xjf &YOCTO_POKY;.tar.bz2
390 $ source &OE_INIT_PATH; &YOCTO_POKY;-build 390 $ cd &YOCTO_POKY;
391 $ source &OE_INIT_FILE;
391 </literallayout> 392 </literallayout>
392 </para> 393 </para>
393 394
@@ -412,12 +413,15 @@
412 <listitem><para>The second command extracts the files from the tarball and places 413 <listitem><para>The second command extracts the files from the tarball and places
413 them into a directory named <filename>&YOCTO_POKY;</filename> in the current 414 them into a directory named <filename>&YOCTO_POKY;</filename> in the current
414 directory.</para></listitem> 415 directory.</para></listitem>
415 <listitem><para>The third command runs the Yocto Project environment setup script. 416 <listitem><para>The third and fourth commands change the working directory to the
416 Running this script defines OpenEmbedded build environment settings needed to 417 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
418 and run the Yocto Project environment setup script.
419 Running this script defines OpenEmbedded build environment settings needed to
417 complete the build. 420 complete the build.
418 The script also creates the 421 The script also creates the
419 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, 422 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>,
420 which is <filename>&YOCTO_POKY;-build</filename> in this case. 423 which is <filename>build</filename> in this case and is located in the
424 source directory.
421 After the script runs, your current working directory is set 425 After the script runs, your current working directory is set
422 to the build directory. 426 to the build directory.
423 Later, when the build completes, the build directory contains all the files 427 Later, when the build completes, the build directory contains all the files
@@ -426,7 +430,7 @@
426 </itemizedlist> 430 </itemizedlist>
427 <para> 431 <para>
428 Take some time to examine your <filename>local.conf</filename> file 432 Take some time to examine your <filename>local.conf</filename> file
429 in your project's configuration directory. 433 in your project's configuration directory, which is found in the build directory.
430 The defaults in that file should work fine. 434 The defaults in that file should work fine.
431 However, there are some variables of interest at which you might look. 435 However, there are some variables of interest at which you might look.
432 </para> 436 </para>