From 5053b654163d5cb209206144f079f42453c6ec1b Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Wed, 23 Jan 2013 15:29:11 -0800
Subject: [PATCH] kernel-dev: General edits and links added.

Many links added to the glossary variables that were introduced
in the manual.

Also provided general edits as I found them.

(From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549)

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

diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 43dec92555..ba288d1311 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -82,10 +82,10 @@
         The linux-yocto style recipes can optionally define the following
         variables:
         <literallayout class='monospaced'>
-     KBRANCH
-     KERNEL_FEATURES
-     KBRANCH_DEFAULT
-     LINUX_KERNEL_TYPE
+     <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'>KBRANCH</ulink>
+     <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink>
+     <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH_DEFAULT'>KBRANCH_DEFAULT</ulink>
+     <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</ulink>
         </literallayout>
         <filename>KBRANCH_DEFAULT</filename> defines the Linux kernel source
         repository's default branch to use to build the Linux kernel.
@@ -104,7 +104,8 @@
         used in assembling the configuration.
         If you do not specify a <filename>LINUX_KERNEL_TYPE</filename>,
         it defaults to "standard".
-        Together with <filename>KMACHINE</filename>,
+        Together with
+        <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
         <filename>LINUX_KERNEL_TYPE</filename> defines the search
         arguments used by the kernel tools to find the
         appropriate description within the kernel Metadata with which to
@@ -139,7 +140,8 @@
         then for the <filename>LINUX_KERNEL_TYPE</filename>.
         If the tools cannot find a partial match, they will use the
         sources from the <filename>KBRANCH</filename> and any configuration
-        specified in the <filename>SRC_URI</filename>.
+        specified in the
+        <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
     </para>
 
     <para>
@@ -394,19 +396,20 @@
         description files within the structure:
         <itemizedlist>
             <listitem><para>If your file contains
-                only configuration fragments, place the file in
-                <filename>cfg</filename>.</para></listitem>
+                only configuration fragments, place the file in the
+                <filename>cfg</filename> directory.</para></listitem>
             <listitem><para>If your file contains
-                only source-code fixes, place the file in
-                <filename>patches</filename>.</para></listitem>
+                only source-code fixes, place the file in the
+                <filename>patches</filename> directory.</para></listitem>
             <listitem><para>If your file encapsulates
                 a major feature, often combining sources and configurations,
-                place the file in <filename>features</filename>.
+                place the file in <filename>features</filename> directory.
                 </para></listitem>
             <listitem><para>If your file aggregates
                 non-hardware configuration and patches in order to define a
                 base kernel policy or major kernel type to be reused across
-                multiple BSPs, place the file in <filename>ktypes</filename>.
+                multiple BSPs, place the file in <filename>ktypes</filename>
+                directory.
                 </para></listitem>
         </itemizedlist>
     </para>
@@ -466,8 +469,8 @@
         </para>
 
         <para>
-            <filename>KFEATURE_DESCRIPTION</filename> provides a short
-            description of the fragment.
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-KFEATURE_DESCRIPTION'><filename>KFEATURE_DESCRIPTION</filename></ulink>
+            provides a short description of the fragment.
             Higher level kernel tools use this description.
         </para>
 
@@ -653,7 +656,8 @@
             It is not strictly necessary to create a kernel type
             <filename>.scc</filename> file.
             The Board Support Package (BSP) file can implicitly define
-            the kernel type using a <filename>define KTYPE myktype</filename>
+            the kernel type using a <filename>define
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'>KTYPE</ulink> myktype</filename>
             line.
             See the "<link linkend='bsp-descriptions'>BSP Descriptions</link>"
             section for more information.
@@ -680,13 +684,15 @@
         kconf mybsp.cfg
             </literallayout>
             Every BSP description should define the
-            <filename>KMACHINE</filename>, <filename>KTYPE</filename>,
-            and <filename>KARCH</filename> variables.
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>,
+            and <ulink url='&YOCTO_DOCS_REF_URL;#var-KARCH'><filename>KARCH</filename></ulink>
+            variables.
             These variables allow the OpenEmbedded build system to identify
             the description as meeting the criteria set by the recipe being
             built.
             This simple example supports the "mybsp" machine for the "standard"
-            kernel and the 'i386" architecture.
+            kernel and the "i386" architecture.
         </para>
 
         <para>
@@ -695,9 +701,9 @@
             description file does not exist.
             Thus, if you do not have kernel types defined in your kernel
             Metadata, you only need to ensure that the kernel recipe's
-            <filename>LINUX_KERNEL_TYPE</filename> variable and the
-            <filename>KTYPE</filename> variable in the BSP description
-            file match.
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink>
+            variable and the <filename>KTYPE</filename> variable in the
+            BSP description file match.
             <note>
                 Future versions of the tooling make the specification of
                 <filename>KTYPE</filename> in the BSP optional.