From ac6bdb4d41bb8b2e1deb78d406ce0d2afb0b8505 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 16 Jun 2014 11:45:19 +0300
Subject: [PATCH] dev-manual, kernel-dev: Provides some cross-reference to
 "clean" stuff.

I scrubbed the manual set for appropriate places to reference into the
do_clean* type tasks.  Found and added several occurrences.

(From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../dev-manual/dev-manual-common-tasks.xml    | 29 ++++++++++++++-----
 documentation/dev-manual/dev-manual-model.xml | 10 +++++--
 .../kernel-dev/kernel-dev-common.xml          | 14 ++++++---
 3 files changed, 39 insertions(+), 14 deletions(-)

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 10c3711b9a..a5cefe499f 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3920,17 +3920,30 @@
                         </literallayout>
                         </para></listitem>
                     <listitem><para><emphasis>Clean up</emphasis>:
-                        Be sure to clean the shared state out by running the
-                        <filename>cleansstate</filename> BitBake task as follows from your Build Directory:
+                        Be sure to clean the shared state out by using BitBake
+                        to run from within the Build Directory the
+                        <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>do_cleansstate</filename></ulink>
+                        task as follows:
                         <literallayout class='monospaced'>
      $ bitbake -c cleansstate linux-yocto
                         </literallayout></para>
-                        <para><note>Never remove any files by hand from the <filename>tmp/deploy</filename>
-                        directory inside the
-                        <link linkend='build-directory'>Build Directory</link>.
-                        Always use the various BitBake clean tasks to clear out previous
-                        build artifacts.
-                        </note></para></listitem>
+                        <para>
+                           <note>
+                               Never remove any files by hand from the
+                               <filename>tmp/deploy</filename>
+                               directory inside the
+                               <link linkend='build-directory'>Build Directory</link>.
+                               Always use the various BitBake clean tasks to
+                               clear out previous build artifacts.
+                               For information on the clean tasks, see the
+                               "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-clean'><filename>do_clean</filename></ulink>",
+                               "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink>",
+                               and
+                               "<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>do_cleansstate</filename></ulink>"
+                               sections all in the Yocto Project Reference
+                               Manual.
+                           </note>
+                        </para></listitem>
                     <listitem><para><emphasis>Build the image</emphasis>:
                         Next, build the kernel image using this command:
                         <literallayout class='monospaced'>
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 59e19a2bae..bd24905ad7 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1785,8 +1785,14 @@
                     If you find problems with your code, you can just keep editing and
                     re-testing iteratively until things work as expected.
                     <note>All the modifications you make to the temporary source code
-                    disappear once you <filename>-c clean</filename> or
-                    <filename>-c cleanall</filename> with BitBake for the package.
+                    disappear once you run the
+                    <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-clean'><filename>do_clean</filename></ulink>
+                    or
+                    <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>do_cleanall</filename></ulink>
+                    tasks using BitBake (i.e.
+                    <filename>bitbake -c clean &lt;name_of_package&gt;</filename>
+                    and
+                    <filename>bitbake -c cleanall &lt;name_of_package&gt;</filename>).
                     Modifications will also disappear if you use the <filename>rm_work</filename>
                     feature as described in the
                     "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 31ffa5c83c..3ab21e7077 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -445,10 +445,16 @@
                 You can edit the sources as you would any other Linux source
                 tree.
                 However, keep in mind that you will lose changes if you
-                trigger the <filename>do_fetch</filename> task for the recipe.
-                You can avoid triggering this task by not issuing BitBake's
-                <filename>cleanall</filename>, <filename>cleansstate</filename>,
-                or forced <filename>fetch</filename> commands.
+                trigger the
+                <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>
+                task for the recipe.
+                You can avoid triggering this task by not using BitBake to
+                run the
+                <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleanall'><filename>cleanall</filename></ulink>,
+                <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-cleansstate'><filename>cleansstate</filename></ulink>,
+                or forced
+                <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>fetch</filename></ulink>
+                commands.
                 Also, do not modify the recipe itself while working
                 with temporary changes or BitBake might run the
                 <filename>fetch</filename> command depending on the