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>

diff --git a/documentation/poky.ent b/documentation/poky.ent
index 342865acfd9f370ddd1f2d56a2404bb071fbb549..5aa4da8ba1312bb987986a8c0a1a9464898ecbb0 100644 (file)
--- a/documentation/poky.ent
+++ b/documentation/poky.ent
@@ -47,3 +47,4 @@
 <!ENTITY YOCTO_ADTPATH_DIR "/opt/poky/&DISTRO;">
 <!ENTITY YOCTO_POKY_TARBALL "&YOCTO_POKY;.tar.bz2">
 <!ENTITY OE_INIT_PATH "&YOCTO_POKY;/oe-init-build-env">
+<!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 b37a45f337d72f9304d121b1474a19da80e533b4..3fde5b7d08f1367d99ded9d7f71fe3eae1f192b1 100644 (file)
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -387,7 +387,8 @@
              <literallayout class='monospaced'>
      $ wget &YOCTO_POKY_DL_URL;
      $ tar xjf &YOCTO_POKY;.tar.bz2
-     $ source &OE_INIT_PATH; &YOCTO_POKY;-build
+     $ cd &YOCTO_POKY;
+     $ source &OE_INIT_FILE;
              </literallayout>
          </para>
 
@@ -412,12 +413,15 @@
              <listitem><para>The second command extracts the files from the tarball and places 
                  them into a directory named <filename>&YOCTO_POKY;</filename> in the current 
                  directory.</para></listitem>
-             <listitem><para>The third command runs the Yocto Project environment setup script.
-                 Running this script defines OpenEmbedded build environment settings needed to 
+             <listitem><para>The third and fourth commands change the working directory to the
+                 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
+                 and run the Yocto Project environment setup script.
+                 Running this script defines OpenEmbedded build environment settings needed to
                  complete the build.
                  The script also creates the 
                  <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>,
-                 which is <filename>&YOCTO_POKY;-build</filename> in this case.
+                 which is <filename>build</filename> in this case and is located in the 
+                 source directory.
                  After the script runs, your current working directory is set 
                  to the build directory.
                  Later, when the build completes, the build directory contains all the files 
@@ -426,7 +430,7 @@
          </itemizedlist>
          <para>
              Take some time to examine your <filename>local.conf</filename> file 
-             in your project's configuration directory.
+             in your project's configuration directory, which is found in the build directory.
              The defaults in that file should work fine.
              However, there are some variables of interest at which you might look.
          </para>