[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6722/8267] dev-manual: Updated "Performing a Simple Build" section.



commit e4f288d519da5d98bae0ba1c4d1841c3f9a8b531
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Tue Jul 4 11:25:36 2017 -0700

    dev-manual: Updated "Performing a Simple Build" section.
    
    I added a figure for this simple build workflow that uses
    BitBake from a Linux host.  Also did a bit of re-writing.
    
    A new figure was introduced so the Makefile had to be adjusted
    to include that figure.  The figure resides in the figures
    directory of both the dev-manual and the mega-manual.
    
    (From yocto-docs rev: c3b0b1d53f551c02202cef80a8a48dd24576b975)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/Makefile                             |    4 +-
 documentation/dev-manual/dev-manual-start.xml      |   49 ++++++++++++++++++--
 .../dev-manual/figures/bitbake-build-flow.png      |  Bin 0 -> 49242 bytes
 .../mega-manual/figures/bitbake-build-flow.png     |  Bin 0 -> 49242 bytes
 4 files changed, 46 insertions(+), 7 deletions(-)
---
diff --git a/documentation/Makefile b/documentation/Makefile
index 167b73e..e32b83a 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -130,7 +130,7 @@ TARFILES = dev-style.css dev-manual.html \
         else
 TARFILES = dev-style.css dev-manual.html \
            figures/dev-title.png \
-           figures/recipe-workflow.png \
+           figures/recipe-workflow.png figures/bitbake-build-flow.png \
            eclipse
        endif
 
@@ -244,7 +244,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
        figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \
        figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \
        figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \
-       figures/sdk-devtool-upgrade-flow.png
+       figures/sdk-devtool-upgrade-flow.png figures/bitbake-build-flow.png
        endif
 
 MANUALS = $(DOC)/$(DOC).html
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 09b13c7..0835650 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -764,18 +764,57 @@
     <title>Performing a Simple Build</title>
 
     <para>
-        The build process creates an entire Linux distribution,
-        including the toolchain, from source.
-        For more information on this topic, see the
+        Several methods exist that allow you to build an image within the
+        Yocto Project.
+        This procedure shows how to build an image using BitBake from a
+        Linux host.
+        <note><title>Notes</title>
+            <itemizedlist>
+                <listitem><para>
+                    For information on how to build an image using
+                    <ulink url='&YOCTO_DOCS_REF_URL;#toaster-term'>Toaster</ulink>,
+                    see the
+                    <ulink url='&YOCTO_DOCS_TOAST_URL;'>Yocto Project Toaster Manual</ulink>.
+                    </para></listitem>
+                <listitem><para>
+                    For information on how to use
+                    <filename>devtool</filename> to build images, see the
+                    "<ulink url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'>Using 
<filename>devtool</filename> in Your SDK Workflow</ulink>"
+                    section in the Yocto Project Software Development Kit
+                    (SDK) Developer's Guide.
+                    </para></listitem>
+            </itemizedlist>
+        </note>
+    </para>
+
+    <para>
+        The build process creates an entire Linux distribution from source
+        and places it in your
+        <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
+        under <filename>tmp/deploy/images</filename>.
+        For detailed information on the build process using BitBake, see the
+        "<ulink url='&YOCTO_DOCS_REF_URL;#images-dev-environment'>Images</ulink>"
+        section in the Yocto Project Reference Manual.
+        You can also reference the
         "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
         section in the Yocto Project Quick Start.
     </para>
 
     <para>
-        Following are the high-level steps for performing a simple build
-        using the Yocto Project:
+        The following figure and list overviews the build process:
+        <imagedata fileref="figures/bitbake-build-flow.png" width="7in" depth="6in" align="center" 
scalefit="1" />
         <orderedlist>
             <listitem><para>
+                <emphasis>Set Up Your Host Development System to Support
+                Development Using the Yocto Project:</emphasis>
+                See the
+                "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>"
+                and the
+                "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>"
+                sections both in the Yocto Project Quick Start for
+                build host requirements.
+                </para></listitem>
+            <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>"
diff --git a/documentation/dev-manual/figures/bitbake-build-flow.png 
b/documentation/dev-manual/figures/bitbake-build-flow.png
new file mode 100644
index 0000000..eb95eb3
Binary files /dev/null and b/documentation/dev-manual/figures/bitbake-build-flow.png differ
diff --git a/documentation/mega-manual/figures/bitbake-build-flow.png 
b/documentation/mega-manual/figures/bitbake-build-flow.png
new file mode 100644
index 0000000..eb95eb3
Binary files /dev/null and b/documentation/mega-manual/figures/bitbake-build-flow.png differ


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