GNOME.org
 

[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6684/8267] documentation: Reorganized YP introduction material.

commit 0f00914578740f4b4ca5216544d512e297610961
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Wed Jun 21 15:07:41 2017 -0700

    documentation: Reorganized YP introduction material.
    
    This material was being replicated across the Quick Start,
    dev-manual, and ref-manual.  I have created a single point in the
    ref-manual that collects the disparate information that existed.
    
    I deleted the entire section in the dev-manual since that book
    is converting to a procedure manual and the very front of the manual
    adequately mentions YP and provides pointers to where the user can
    get more information.
    
    The QS provides a more complete introduction of YP since it is a
    QS.
    
    (From yocto-docs rev: bd8093417af2d93556410d5482dad32c11a0a964)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/dev-manual/dev-manual-start.xml      |   48 ++------------------
 documentation/ref-manual/introduction.xml          |   41 +++++++++++++----
 .../yocto-project-qs/yocto-project-qs.xml          |    8 +++-
 3 files changed, 42 insertions(+), 55 deletions(-)
---
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 3156731..7644362 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -7,53 +7,13 @@
 <title>Getting Started with the Yocto Project</title>
 
 <para>
-    This chapter introduces the Yocto Project and gives you an idea of what you need to get started.
-    You can find enough information to set up your development host and build or use images for
-    hardware supported by the Yocto Project by reading the
+    This chapter provides procedures related to getting set up to use the
+    Yocto Project.
+    For a more front-to-end process that takes you from minimally preparing
+    a build host through building an image, see the
     <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
 </para>
 
-<para>
-    The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides
-    some higher-level concepts you might want to consider.
-</para>
-
-<section id='introducing-the-yocto-project'>
-    <title>Introducing the Yocto Project</title>
-
-    <para>
-        The Yocto Project is an open-source collaboration project focused on embedded Linux development.
-        The project currently provides a build system that is
-        referred to as the
-        <ulink url='&YOCTO_DOCS_REF_URL;#build-system-term'>OpenEmbedded build system</ulink>
-        in the Yocto Project documentation.
-        The Yocto Project provides various ancillary tools for the embedded developer
-        and also features the Sato reference User Interface, which is optimized for
-        stylus-driven, low-resolution screens.
-    </para>
-
-    <para>
-        You can use the OpenEmbedded build system, which uses
-        <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>,
-        to develop complete Linux
-        images and associated user-space applications for architectures based
-        on ARM, MIPS, PowerPC, x86 and x86-64.
-        <note>
-            By default, using the Yocto Project creates a Poky distribution.
-            However, you can create your own distribution by providing key
-            <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>.
-            See the "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>"
-            section for more information.
-        </note>
-        While the Yocto Project does not provide a strict testing framework,
-        it does provide or generate for you artifacts that let you perform target-level and
-        emulated testing and debugging.
-        Additionally, if you are an <trademark class='trade'>Eclipse</trademark>
-        IDE user, you can install an Eclipse Yocto Plug-in to allow you to
-        develop within that familiar environment.
-    </para>
-</section>
-
 <section id='getting-setup'>
     <title>Getting Set Up</title>
 
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 98b3ca8..473afb5 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -49,20 +49,41 @@
     <para>
         The Yocto Project is an open-source collaboration project whose
         focus is for developers of embedded Linux systems.
-        Among other things, the Yocto Project uses a build host based
-        on the OpenEmbedded (OE) project, which uses the
-        <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>
-        tool, to construct complete Linux images.
-        The BitBake and OE components are combined together to form
-        a reference build host, historically known as
-        <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>
-        (<emphasis>Pah</emphasis>-kee).
+        Among other things, the Yocto Project uses an
+        <link linkend='build-system-term'>OpenEmbedded build system</link>.
+        The build system, which is based on the OpenEmbedded (OE) project and
+        uses the
+        <link linkend='bitbake-term'>BitBake</link> tool, constructs complete
+        Linux images for architectures based on ARM, MIPS, PowerPC, x86 and
+        x86-64.
+        <note>
+            Historically, the OpenEmbedded build system, which is the
+            combination of BitBake and OE components, formed a reference
+            build host that was known as
+            "<link linkend='poky'>Poky</link>" (<emphasis>Pah</emphasis>-kee).
+            The term "Poky", as used throughout the Yocto Project Documentation
+            set, can have different meanings.
+        </note>
+        The Yocto Project provides various ancillary tools for the embedded
+        developer and also features the Sato reference User Interface, which
+        is optimized for stylus-driven, low-resolution screens.
+    </para>
+
+    <para>
+        While the Yocto Project does not provide a strict testing framework,
+        it does provide or generate for you artifacts that let you perform
+        target-level and emulated testing and debugging.
+        Additionally, if you are an
+        <trademark class='trade'>Eclipse</trademark> IDE user, you can
+        install an Eclipse Yocto Plug-in to allow you to develop within that
+        familiar environment.
     </para>
 
     <para>
-        By default, using the Yocto Project creates a Poky distribution.
+        By default, using the Yocto Project to build an image creates a Poky
+        distribution.
         However, you can create your own distribution by providing key
-        <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>.
+        <link link='metadata'>Metadata</link>.
         A good example is Angstrom, which has had a distribution
         based on the Yocto Project since its inception.
         Other examples include commercial distributions like
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml 
b/documentation/yocto-project-qs/yocto-project-qs.xml
index 197ddd5..285d326 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -64,7 +64,7 @@
             tool, to construct complete Linux images.
             The BitBake and OE components are combined together to form
             a reference build host, historically known as
-            <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>
+            <ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink>
             (<emphasis>Pah</emphasis>-kee).
         </para>
 
@@ -102,6 +102,12 @@
             reference these resources:
             <itemizedlist>
                 <listitem><para>
+                    <emphasis>Yocto Project Backgrounders:</emphasis>
+                    The
+                    <ulink url='&YOCTO_HOME_URL;/ecosystem/yocto-project-backgrounders'>Yocto Project 
Backgrounder</ulink>
+                    provides introductory information on the Yocto Project.
+                    </para></listitem>
+                <listitem><para>
                     <emphasis>Website:</emphasis>
                     The
                     <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]