GNOME.org
 

[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6709/8267] dev-manual, kernel-dev: Moved the kernel build hierarchy section

commit b643938bdecd4ed928713c3a9b4c9f7e0e637964
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Thu Jun 29 15:54:35 2017 -0700

    dev-manual, kernel-dev: Moved the kernel build hierarchy section
    
    Fixes [YOCTO #11630]
    
    The section that presented the Yocto Linux kernel file structure
    resulting from a build using BitBake needed to be in the kernel-dev
    manual.  I moved it over.  This required transferring over a
    figure as well.
    
    (From yocto-docs rev: 0abc6c7d87a6aa10dac28fefbb280eb51fea61a7)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/Makefile                             |    3 +-
 documentation/dev-manual/dev-manual-model.xml      |   71 +---------------
 .../figures/kernel-overview-2-generic.png          |  Bin 49230 -> 49230 bytes
 .../kernel-dev/kernel-dev-concepts-appx.xml        |   87 ++++++++++++++++++++
 4 files changed, 91 insertions(+), 70 deletions(-)
---
diff --git a/documentation/Makefile b/documentation/Makefile
index a761c19..93cf6ca 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -131,7 +131,6 @@ TARFILES = dev-style.css dev-manual.html \
 TARFILES = dev-style.css dev-manual.html \
            figures/dev-title.png \
            figures/kernel-dev-flow.png \
-           figures/kernel-overview-2-generic.png \
            figures/recipe-workflow.png \
            figures/devtool-add-flow.png figures/devtool-modify-flow.png \
            figures/devtool-upgrade-flow.png \
@@ -330,7 +329,7 @@ ifeq ($(DOC),kernel-dev)
 XSLTOPTS = --xinclude
 ALLPREQ = html eclipse tarball
 TARFILES = kernel-dev.html kernel-dev-style.css \
-           figures/kernel-dev-title.png \
+           figures/kernel-dev-title.png figures/kernel-overview-2-generic \
            figures/kernel-architecture-overview.png \
            eclipse
 MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 05ff369..0055bcc 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -82,71 +82,6 @@
             <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>.
         </para>
 
-        <section id='kernel-overview'>
-            <title>Kernel Overview</title>
-
-            <para>
-                Upstream storage of all the available kernel source code is
-                one thing, while representing and using the code on your host
-                development system is another.
-                Conceptually, you can think of the kernel source repositories
-                as all the source files necessary for all the supported
-                Yocto Linux kernels.
-                As a developer, you are just interested in the source files
-                for the kernel on which you are working.
-                And, furthermore, you need them available on your host system.
-            </para>
-
-            <para>
-                Kernel source code is available on your host system a couple
-                of different ways.
-                If you are working in the kernel all the time, you probably
-                would want to set up your own local Git repository of the
-                Yocto Linux kernel tree.
-                If you just need to make some patches to the kernel, you can
-                access temporary kernel source files that were extracted and
-                used during a build.
-                We will just talk about working with the temporary source code.
-                For more information on how to get kernel source code onto your
-                host system, see the
-                "<link linkend='local-kernel-files'>Setting Up to Work On a Kernel</link>"
-                section.
-            </para>
-
-            <para>
-                What happens during the build?
-                When you build the kernel on your development system, all files needed for the build
-                are taken from the source repositories pointed to by the
-                <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> variable
-                and gathered in a temporary work area
-                where they are subsequently used to create the unique kernel.
-                Thus, in a sense, the process constructs a local source tree specific to your
-                kernel to generate the new kernel image - a source generator if you will.
-            </para>
-
-            <para>
-                The following figure shows the temporary file structure
-                created on your host system when the build occurs.
-                This
-                <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
-                contains all the source files used during the build.
-            </para>
-
-            <para>
-                <imagedata fileref="figures/kernel-overview-2-generic.png"
-                    width="6in" depth="5in" align="center" scale="100" />
-            </para>
-
-            <para>
-                Again, for additional information on the Yocto Project kernel's
-                architecture and its branching strategy, see the
-                <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development 
Manual</ulink>.
-                You can also reference the
-                "<link linkend='patching-the-kernel'>Patching the Kernel</link>"
-                section for a detailed example that modifies the kernel.
-            </para>
-        </section>
-
         <section id='kernel-modification-workflow'>
             <title>Kernel Modification Workflow</title>
 
@@ -219,9 +154,9 @@
                             Try to resist the temptation to directly edit an
                             existing <filename>.config</filename> file, which is
                             found in the Build Directory among the source code
-                            used for the build (e.g. see the bottom
-                            illustration in the
-                            "<link linkend='kernel-overview'>Kernel Overview</link>"
+                            used for the build (e.g. see the workflow illustration
+                            in the
+                            "<link linkend='kernel-modification-workflow'>Kernel Modification 
Workflow</link>"
                             section).
                             Doing so, can produce unexpected results when the
                             OpenEmbedded build system regenerates the configuration
diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.xml 
b/documentation/kernel-dev/kernel-dev-concepts-appx.xml
index 7c9f34c..8eb8c30 100644
--- a/documentation/kernel-dev/kernel-dev-concepts-appx.xml
+++ b/documentation/kernel-dev/kernel-dev-concepts-appx.xml
@@ -380,6 +380,93 @@
             cloning and building the kernel.
         </para>
     </section>
+
+    <section id='kernel-build-file-hierarchy'>
+        <title>Kernel Build File Hierarchy</title>
+
+        <para>
+            Upstream storage of all the available kernel source code is
+            one thing, while representing and using the code on your host
+            development system is another.
+            Conceptually, you can think of the kernel source repositories
+            as all the source files necessary for all the supported
+            Yocto Linux kernels.
+            As a developer, you are just interested in the source files
+            for the kernel on which you are working.
+            And, furthermore, you need them available on your host system.
+        </para>
+
+        <para>
+            Kernel source code is available on your host system several
+            different ways:
+            <itemizedlist>
+                <listitem><para>
+                    <emphasis>Files Accessed While using <filename>devtool</filename>:</emphasis>
+                    <filename>devtool</filename>, which is available with the
+                    Yocto Project, is the preferred method by which to
+                    modify the kernel.
+                    See the
+                    "<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-modification-workflow'>Kernel Modification 
Workflow</ulink>"
+                    section in the Yocto Project Development Manual for
+                    information.
+                    </para></listitem>
+                <listitem><para>
+                    <emphasis>Cloned Repository:</emphasis>
+                    If you are working in the kernel all the time, you probably
+                    would want to set up your own local Git repository of the
+                    Yocto Linux kernel tree.
+                    For information on how to clone a Yocto Linux kernel
+                    Git repository, see the
+                    "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Setting Up to Work On a 
Kernel</ulink>"
+                    section in the Yocto Project Development Manual.
+                    </para></listitem>
+                <listitem><para>
+                    <emphasis>Temporary Source Files from a Build:</emphasis>
+                    If you just need to make some patches to the kernel using
+                    a traditional BitBake workflow (i.e. not using the
+                    <filename>devtool</filename>), you can access temporary
+                    kernel source files that were extracted and used during
+                    a kernel build.
+                    </para></listitem>
+            </itemizedlist>
+        </para>
+
+        <para>
+            The temporary kernel source files resulting from a build using
+            BitBake have a particular hierarchy.
+            When you build the kernel on your development system, all files
+            needed for the build are taken from the source repositories
+            pointed to by the
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>
+            variable and gathered in a temporary work area where they are
+            subsequently used to create the unique kernel.
+            Thus, in a sense, the process constructs a local source tree
+            specific to your kernel from which to generate the new kernel
+            image.
+        </para>
+
+        <para>
+            The following figure shows the temporary file structure
+            created on your host system when you build the kernel using
+            Bitbake.
+            This
+            <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
+            contains all the source files used during the build.
+            <imagedata fileref="figures/kernel-overview-2-generic.png"
+                width="6in" depth="5in" align="center" scale="100" />
+        </para>
+
+        <para>
+            Again, for additional information on the Yocto Project kernel's
+            architecture and its branching strategy, see the
+            "<link linkend='yocto-linux-kernel-architecture-and-branching-strategies'>Yocto Linux Kernel 
Architecture and Branching Strategies</link>"
+            section.
+            You can also reference the
+            "<ulink url='&YOCTO_DOCS_DEV_URL;#patching-the-kernel'>Patching the Kernel</ulink>"
+            section in the Yocto Project Development Manual for a detailed
+            example that modifies the kernel.
+        </para>
+    </section>
 </appendix>
 <!--
 vim: expandtab tw=80 ts=4
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]