GNOME.org
 

[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6717/8267] documentation: Moved devtool workflow to sdk manual

commit 293b53674c1c97a29a8beaffc82130e90c0d3c2b
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Mon Jul 3 15:27:58 2017 -0700

    documentation: Moved devtool workflow to sdk manual
    
    Fixes [YOCTO #11630]
    
    The section on the devtool workflow in the dev-manual was 99%
    identical to what was in the sdk-manual.  I have moved the
    workflow procedure from the old "Model" chapter of the dev-manual
    to be merged with what was in the sdk-manual.  In truth, the
    only things added were a note about devtool not being exclusive
    to SDK development.
    
    The result of moving (deleting) this section was that the "model"
    chapter of the dev-manual went away.  The devtool stuff, Quilt,
    devshell, and python shell are all out now and there is no
    chapter left.  So, mega-manual had to be adjusted to not pull that
    chapter in when building the dev-manual.  I had to delete three
    figures that were used in the flow.  The figures were already
    replicated in the sdk-manual.  The figures were deleted from the
    figures folder of both the dev-manual and the mega-manual.
    
    I had to make sure all references to the old devtool stuf in the
    YP doc set were adjusted.
    
    (From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/Makefile                             |    5 +-
 .../dev-manual/dev-manual-common-tasks.xml         |   17 +-
 documentation/dev-manual/dev-manual-model.xml      |  721 --------------------
 documentation/dev-manual/dev-manual-start.xml      |    8 +-
 documentation/dev-manual/dev-manual.xml            |    2 -
 .../dev-manual/figures/devtool-add-flow.png        |  Bin 177945 -> 0 bytes
 .../dev-manual/figures/devtool-modify-flow.png     |  Bin 164192 -> 0 bytes
 .../dev-manual/figures/devtool-upgrade-flow.png    |  Bin 139827 -> 0 bytes
 documentation/kernel-dev/kernel-dev-intro.xml      |    8 +-
 .../mega-manual/figures/devtool-add-flow.png       |  Bin 179361 -> 0 bytes
 .../mega-manual/figures/devtool-modify-flow.png    |  Bin 152662 -> 0 bytes
 .../mega-manual/figures/devtool-upgrade-flow.png   |  Bin 140597 -> 0 bytes
 documentation/mega-manual/mega-manual.xml          |    2 -
 documentation/sdk-manual/sdk-extensible.xml        |   15 +-
 .../yocto-project-qs/yocto-project-qs.xml          |    4 +-
 15 files changed, 34 insertions(+), 748 deletions(-)
---
diff --git a/documentation/Makefile b/documentation/Makefile
index 770ef93..167b73e 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -131,8 +131,6 @@ TARFILES = dev-style.css dev-manual.html \
 TARFILES = dev-style.css dev-manual.html \
            figures/dev-title.png \
            figures/recipe-workflow.png \
-           figures/devtool-add-flow.png figures/devtool-modify-flow.png \
-           figures/devtool-upgrade-flow.png \
            eclipse
        endif
 
@@ -241,8 +239,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
        figures/sdk-generation.png figures/recipe-workflow.png \
        figures/build-workspace-directory.png figures/mega-title.png \
        figures/toaster-title.png figures/hosted-service.png \
-       figures/simple-configuration.png figures/devtool-add-flow.png \
-       figures/devtool-modify-flow.png figures/devtool-upgrade-flow.png \
+       figures/simple-configuration.png \
        figures/compatible-layers.png figures/import-layer.png figures/new-project.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 \
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml 
b/documentation/dev-manual/dev-manual-common-tasks.xml
index c6efcf6..f040c40 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1516,8 +1516,9 @@
                 <para>
                     You can find a complete description of the
                     <filename>devtool add</filename> command in the
-                    "<link linkend='use-devtool-to-integrate-new-code'>Use <filename>devtool add</filename> 
to Add an Application</link>"
-                    section.
+                    "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-a-closer-look-at-devtool-add'>A Closer Look at 
<filename>devtool</filename> add</ulink>"
+                    section in the Yocto Project Software Development Kit
+                    (SDK) Developer's Guide.
                 </para>
             </section>
 
@@ -4081,10 +4082,11 @@
             <note><title>Tip</title>
                 With regard to preserving changes to source files, if you
                 clean a recipe or have <filename>rm_work</filename> enabled,
-                the workflow described in the
-                "<link linkend='using-devtool-in-your-workflow'>Using <filename>devtool</filename> in Your 
Workflow</link>"
-                section is a safer development flow than the flow that
-                uses Quilt.
+                the
+                <ulink 
url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename> workflow</ulink>
+                as described in the Yocto Project Software Development Kit
+                (SDK) Developer's Guide is a safer development flow than the
+                flow that uses Quilt.
             </note>
         </para>
 
@@ -6966,7 +6968,8 @@
 
             <para>
                 Two methods exist by which you can create the patch:
-                <link linkend='using-devtool-in-your-workflow'><filename>devtool</filename></link> and
+                <ulink 
url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename></ulink>
+                and
                 <link linkend='using-a-quilt-workflow'>Quilt</link>.
                 For kernel patches, the Git workflow is more appropriate.
                 This section assumes the Git workflow and shows the steps specific to
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 3757653..09b13c7 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -199,10 +199,10 @@
         <title>Setting Up to Work on a Kernel</title>
 
         <para>
-            Kernel development is best accomplished using the
-            <filename>devtool</filename> tool and not through traditional
-            kernel workflow methods.
-            This section provides procedures for both.
+            Kernel development is best accomplished using
+            <ulink 
url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename></ulink>
+            and not through traditional kernel workflow methods.
+            This section provides procedures to set up for both.
         </para>
 
         <section id='getting-ready-to-develop-using-devtool'>
diff --git a/documentation/dev-manual/dev-manual.xml b/documentation/dev-manual/dev-manual.xml
index 55cacb7..e7eb70d 100644
--- a/documentation/dev-manual/dev-manual.xml
+++ b/documentation/dev-manual/dev-manual.xml
@@ -152,8 +152,6 @@
 
     <xi:include href="dev-manual-newbie.xml"/>
 
-    <xi:include href="dev-manual-model.xml"/>
-
     <xi:include href="dev-manual-common-tasks.xml"/>
 
     <xi:include href="dev-manual-qemu.xml"/>
diff --git a/documentation/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml
index e62fb67..bb03c60 100644
--- a/documentation/kernel-dev/kernel-dev-intro.xml
+++ b/documentation/kernel-dev/kernel-dev-intro.xml
@@ -237,7 +237,7 @@
     <title>Other Resources</title>
 
     <para>
-        The sections that follow provide instructions for completing
+        The remainder of this manual provides instructions for completing
         specific Linux kernel development tasks.
         These instructions assume you are comfortable working with
         <ulink url='http://openembedded.org/wiki/Bitbake'>BitBake</ulink>
@@ -251,9 +251,9 @@
                 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>
                 </para></listitem>
             <listitem><para>
-                The
-                "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-modifying-source-code'>Modifying Source Code</ulink>"
-                section in the Yocto Project Development Manual
+                <ulink 
url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'><filename>devtool</filename> workflow</ulink>
+                as described in the Yocto Project Software Development Kit
+                (SDK) Developer's Guide.
                 </para></listitem>
             <listitem><para>
                 The
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml
index a6fdce5..d7d6614 100644
--- a/documentation/mega-manual/mega-manual.xml
+++ b/documentation/mega-manual/mega-manual.xml
@@ -131,8 +131,6 @@
     <xi:include
         xmlns:xi="http://www.w3.org/2003/XInclude"; href="../dev-manual/dev-manual-newbie.xml"/>
     <xi:include
-        xmlns:xi="http://www.w3.org/2003/XInclude"; href="../dev-manual/dev-manual-model.xml"/>
-    <xi:include
         xmlns:xi="http://www.w3.org/2003/XInclude"; href="../dev-manual/dev-manual-common-tasks.xml"/>
     <xi:include
         xmlns:xi="http://www.w3.org/2003/XInclude"; href="../dev-manual/dev-manual-qemu.xml"/>
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 415cf67..2fd1a7e 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -235,6 +235,13 @@
             you build, test and package software within the extensible SDK, and
             optionally integrate it into an image built by the OpenEmbedded
             build system.
+            <note><title>Tip</title>
+                The use of <filename>devtool</filename> is not limited to
+                the extensible SDK.
+                You can use <filename>devtool</filename> to help you easily
+                develop any project whose build output must be part of an
+                image built using the OpenEmbedded build system.
+            </note>
         </para>
 
         <para>
@@ -244,6 +251,12 @@
             number of sub-commands for each function.
             You can run <filename>devtool --help</filename> to see all the
             commands.
+            <note>
+                See the
+                "<ulink 
url='&YOCTO_DOCS_REF_URL;#ref-devtool-reference'><filename>devtool</filename>&nbsp;Quick Reference</ulink>"
+                in the Yocto Project Reference Manual for a
+                <filename>devtool</filename> quick reference.
+            </note>
         </para>
 
         <para>
@@ -1262,7 +1275,7 @@
         <title>Working With Recipes</title>
 
         <para>
-            When building a recipe with <filename>devtool build</filename> the
+            When building a recipe with <filename>devtool build</filename>, the
             typical build progression is as follows:
             <orderedlist>
                 <listitem><para>
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml 
b/documentation/yocto-project-qs/yocto-project-qs.xml
index 78881d4..409d537 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -945,9 +945,7 @@
                     is a great place to get a feel for how to use the Yocto
                     Project.
                     The manual contains conceptual and procedural information
-                    that covers
-                    <ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-model'>common development models</ulink>
-                    and introduces
+                    that introduces
                     <ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-newbie'>the Yocto Project open source 
development environment</ulink>.
                     The manual also contains several targeted sections that
                     cover specific
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]