From eb576addf539e75295c34352ad73a27242156978 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Wed, 23 Jan 2013 13:36:00 -0800
Subject: kernel-dev: Links and edits to the Common Tasks chapter.

(From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/kernel-dev/kernel-dev-common.xml | 28 ++++++++++++++++----------
 1 file changed, 17 insertions(+), 11 deletions(-)

(limited to 'documentation')

diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 475149368b..f6c027e7c5 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -7,7 +7,7 @@
 <title>Common Tasks</title>
 
 <para>
-    This chapter presents several common tasks that are performed when you
+    This chapter presents several common tasks you perform when you
     work with the Yocto Project Linux kernel.
     These tasks include preparing a layer, modifying an existing recipe,
     iterative development, working with your own sources, and incorporating
@@ -29,7 +29,7 @@
             sections in the Yocto Project Development Manual:
             <itemizedlist>
                 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" for
-                    general information on layers and how to create them.</para></listitem>
+                    general information on layers and how to create layers.</para></listitem>
                 <listitem><para>"<ulink url='&YOCTO_DOCS_DEV_URL;#get-your-layer-setup-for-the-build'>Get Your Layer Setup for the Build</ulink>" for
                     specific instructions on setting up a layer for kernel
                     development.</para></listitem>
@@ -238,7 +238,7 @@
                 The resulting <filename>.config</filename> file is
                 located in
                 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> under the
-                <filename>linux-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink><filename>}-${KTYPE}-build</filename> directory.
+                <filename>linux-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink><filename>}-${<ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>}-build</filename> directory.
                 You can use the entire <filename>.config</filename> file as the
                 <filename>defconfig</filename> file as described in the
                 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section.
@@ -612,11 +612,14 @@
 
         <para>
             The important point to note here is the
-            <filename>KERNEL_SRC</filename> variable.
-            The module <filename>bbclass</filename> sets this variable,
-            as well as the <filename>KERNEL_PATH</filename> variable
-            to <filename>${STAGING_KERNEL_DIR}</filename> with the
-            necessary Linux kernel build information to build modules.
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_SRC'><filename>KERNEL_SRC</filename></ulink>
+            variable.
+            The class <filename>module.bbclass</filename> sets this variable,
+            as well as the
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_PATH'><filename>KERNEL_PATH</filename></ulink>
+            variable to
+            <filename>${<ulink url='&YOCTO_DOCS_REF_URL;#var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></ulink>}</filename>
+            with the necessary Linux kernel build information to build modules.
             If your module <filename>Makefile</filename> uses a different
             variable, you might want to override the
             <filename>do_compile()</filename> step, or create a patch to
@@ -656,9 +659,12 @@
         </para>
 
         <para>
-            Because the variable is <filename>RRECOMMENDS</filename> and not
-            a <filename>RDEPENDS</filename> variable, the build will not fail
-            if this module is not available to include in the image.
+            Because the variable is
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-RRECOMMENDS'><filename>RRECOMMENDS</filename></ulink>
+            and not a
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-RDEPENDS'><filename>RDEPENDS</filename></ulink>
+            variable, the build will not fail if this module is not available
+            to include in the image.
         </para>
     </section>
 </chapter>
-- 
cgit v1.2.3-54-g00ecf