[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6693/8267] dev-manual: Updated "Building Images" section



commit 15a41d25e961b4e4becc549cbbb25573c51cadfa
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Wed Jun 28 10:02:34 2017 -0700

    dev-manual: Updated "Building Images" section
    
    Fixes [YOCTO #11630]
    
    I re-wrote the "Building Images" section into a "Performing
    a Simple Build" section.  A single link in the common tasks
    chapter was affected by the section name change.
    
    (From yocto-docs rev: de5a4cfa4f63538fe0a5ec0c2aacfb9222b70c4b)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/dev-manual/dev-manual-start.xml |   46 +++++++++++++++++--------
 1 files changed, 31 insertions(+), 15 deletions(-)
---
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index e1b2e5d..459254c 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -730,45 +730,61 @@
     </section>
 </section>
 
-<section id='building-images'>
-    <title>Building Images</title>
+<section id='performing-a-simple-build'>
+    <title>Performing a Simple Build</title>
 
     <para>
-        The build process creates an entire Linux distribution, including the toolchain, from source.
+        The build process creates an entire Linux distribution,
+        including the toolchain, from source.
         For more information on this topic, see the
         "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
         section in the Yocto Project Quick Start.
     </para>
 
     <para>
-        The build process is as follows:
+        Following are the high-level steps for performing a simple build
+        using the Yocto Project:
         <orderedlist>
-            <listitem><para>Make sure you have set up the Source Directory described in the
-                previous section.</para></listitem>
-            <listitem><para>Initialize the build environment by sourcing a build
+            <listitem><para>
+                <emphasis>Set Up Your Source Directories:</emphasis>
+                Make sure you have set up the Source Directory described in the
+                "<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> 
Repository</link>"
+                section.
+                </para></listitem>
+            <listitem><para>
+                <emphasis>Initialize the Build Environment:</emphasis>
+                Initialize the build environment by sourcing a build
                 environment 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>).
                 </para></listitem>
-            <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file,
-                which is found in the
+            <listitem><para>
+                <emphasis>Make Sure Your <filename>local.conf</filename>
+                File is Correct:</emphasis>
+                Ensure the <filename>conf/local.conf</filename> configuration
+                file, which is found in the
                 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
                 is set up how you want it.
-                This file defines many aspects of the build environment including
-                the target machine architecture through the
+                This file defines many aspects of the build environment
+                including the target machine architecture through the
                 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable,
                 the packaging format used during the build
                 (<ulink 
url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>),
                 and a centralized tarball download directory through the
-                <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> 
variable.</para></listitem>
+                <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.
+                </para></listitem>
             <listitem><para>
+                <emphasis>Build the Image:</emphasis>
                 Build the image using the <filename>bitbake</filename> command.
-                If you want information on BitBake, see the
+                For example, the following command builds the
+                <filename>core-image-minimal</filename> image:
+                <literallayout class='monospaced'>
+     $ bitbake core-image-minimal
+                </literallayout>
+                For information on BitBake, see the
                 <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>.
                 </para></listitem>
-            <listitem><para>Run the image either on the actual hardware or using the QEMU
-                emulator.</para></listitem>
         </orderedlist>
     </para>
 </section>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]