[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6393/8267] documentation: Re-org for "closer-look" chapter



commit de6d45fefc3000ee8918d7c18448758d4216bae5
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Wed Jun 14 09:50:55 2017 -0700

    documentation: Re-org for "closer-look" chapter
    
    Fixes [YOCTO #11630]
    
    The ref-manual needs expansion for the old "closer-look" chapter.
    This chapter previously held a detailed look at what happens when
    a user uses the YP to develop something.  Now, the chapter needs
    to also contain YP development environment concepts (e.g. open-
    source philosophy, etc.), which are coming from the dev-manual.
    
    Because of this, I renamed the "closer-look.xml" chapter to be
    "ref-development-environment.xml".  I also renamed the larger
    section that was formerly the entire chapter into its own section
    named "Development Concepts".
    
    Both these changes caused a few links to break.  I fixed all the
    links from within the various manuals so they would find appropriate
    targets.
    
    I did some re-writing for introductory material to introduce the new
    chapter and the section on "Development Concepts".
    
    A new file ("ref-development-environment.xml") was added by basically
    renaming the "closer-look.xml" chapter.  And, the tracking for
    "closer-look.xml" was deleted.
    
    (From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 .../dev-manual/dev-manual-common-tasks.xml         |    4 +-
 ...er-look.xml => ref-development-environment.xml} |   26 +++++++++++++-------
 documentation/ref-manual/ref-manual.xml            |    2 +-
 documentation/ref-manual/technical-details.xml     |    4 +-
 .../yocto-project-qs/yocto-project-qs.xml          |    2 +-
 5 files changed, 23 insertions(+), 15 deletions(-)
---
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml 
b/documentation/dev-manual/dev-manual-common-tasks.xml
index 8f39d19..0a9c180 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2083,8 +2083,8 @@
             </para>
 
             <para>
-                You can find more information about the build process in the
-                "<ulink url='&YOCTO_DOCS_REF_URL;#closer-look'>A Closer Look at the Yocto Project 
Development Environment</ulink>"
+                You can find more information about the build process in
+                "<ulink url='&YOCTO_DOCS_REF_URL;#ref-development-environment'>The Yocto Project Development 
Environment</ulink>"
                 chapter of the Yocto Project Reference Manual.
             </para>
         </section>
diff --git a/documentation/ref-manual/closer-look.xml 
b/documentation/ref-manual/ref-development-environment.xml
similarity index 99%
rename from documentation/ref-manual/closer-look.xml
rename to documentation/ref-manual/ref-development-environment.xml
index 5046465..a30cefc 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/ref-development-environment.xml
@@ -2,18 +2,26 @@
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd";
 [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
 
-<chapter id='closer-look'>
-<title>A Closer Look at the Yocto Project Development Environment</title>
+<chapter id='ref-development-environment'>
+<title>The Yocto Project Development Environment</title>
 
     <para>
-        This chapter takes a more detailed look at the Yocto Project
-        development environment.
-        The following diagram represents the development environment at a
-        high level.
+        This chapter takes a look at the Yocto Project development
+        environment and also provides a detailed look at what goes on during
+        development in that environment.
+    </para>
+
+<section id="development-concepts">
+    <title>Development Concepts</title>
+
+    <para>
+        This section takes a more detailed look inside the development
+        process.
+        The following diagram represents development at a high level.
         The remainder of this chapter expands on the fundamental input, output,
         process, and
         <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>) blocks
-        in the Yocto Project development environment.
+        that make up development in the Yocto Project environment.
     </para>
 
     <para id='general-yocto-environment-figure'>
@@ -21,8 +29,7 @@
     </para>
 
     <para>
-        The generalized Yocto Project Development Environment consists of
-        several functional areas:
+        In general, development consists of several functional areas:
         <itemizedlist>
             <listitem><para><emphasis>User Configuration:</emphasis>
                 Metadata you can use to control the build process.
@@ -1620,6 +1627,7 @@
             </itemizedlist>
         </para>
     </section>
+</section>
 
 </chapter>
 <!--
diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml
index 16900ad..8096871 100644
--- a/documentation/ref-manual/ref-manual.xml
+++ b/documentation/ref-manual/ref-manual.xml
@@ -163,7 +163,7 @@
 
     <xi:include href="usingpoky.xml"/>
 
-    <xi:include href="closer-look.xml"/>
+    <xi:include href="ref-development-environment.xml"/>
 
     <xi:include href="technical-details.xml"/>
 
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index 768f701..7fc2e18 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -55,8 +55,8 @@
         Following are some brief details on these core components.
         For additional information on how these components interact during
         a build, see the
-        "<link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>"
-        Chapter.
+        "<link linkend='development-concepts'>Development Concepts</link>"
+        section.
     </para>
 
     <section id='usingpoky-components-bitbake'>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml 
b/documentation/yocto-project-qs/yocto-project-qs.xml
index 1d9bd9f..527fcd8 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -948,7 +948,7 @@
                     You can get
                     <ulink url='&YOCTO_DOCS_REF_URL;#usingpoky'>build details</ulink>,
                     a
-                    <ulink url='&YOCTO_DOCS_REF_URL;#closer-look'>closer look</ulink>
+                    <ulink url='&YOCTO_DOCS_REF_URL;#development-concepts'>closer look</ulink>
                     at how the pieces of the Yocto Project development
                     environment work together, information on various
                     <ulink url='&YOCTO_DOCS_REF_URL;#technical-details'>technical details</ulink>,


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