From 5174240361acc138cb7b39fa5d84bfbce4fbcce1 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 28 Jan 2013 13:14:19 -0600
Subject: kernel-dev: Added "-dirty String" section.

The "-dirty" String section from the old YP Kernel Architecture
and Use Manual was moved to section 2.3 of the manual.  It needs
to find the right area to be put in (AR for Darren).  I added the
AR text to the top of the section so it would not fall through
the cracks.

(From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e)

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 | 43 ++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

(limited to 'documentation')

diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 235bc41525..373a3fe936 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -217,6 +217,49 @@
             "linux-yocto".
         </para>
 
+        <section id='tip-dirty-string'>
+            <title>"-dirty" String</title>
+
+            <para>
+                <emphasis>AR - Darrren Hart:</emphasis>  This section
+                originated from the old Yocto Project Kernel Architecture
+                and Use Manual.
+                It was decided we need to put it in this section here.
+                Darren needs to figure out where we want it and what part
+                of it we want (all, revision???)
+            </para>
+
+            <para>
+                If kernel images are being built with "-dirty" on the
+                end of the version string, this simply means that
+                modifications in the source directory have not been committed.
+                <literallayout class='monospaced'>
+     $ git status
+                </literallayout>
+            </para>
+
+            <para>
+                You can use the above Git command to report modified,
+                removed, or added files.
+                You should commit those changes to the tree regardless of
+                whether they will be saved, exported, or used.
+                Once you commit the changes, you need to rebuild the kernel.
+            </para>
+
+            <para>
+                To force a pickup and commit of all such pending changes,
+                enter the following:
+                <literallayout class='monospaced'>
+     $ git add .
+     $ git commit -s -a -m "getting rid of -dirty"
+                </literallayout>
+            </para>
+
+            <para>
+                Next, rebuild the kernel.
+            </para>
+        </section>
+
         <section id='generating-configuration-files'>
             <title>Generating Configuration Files</title>
 
-- 
cgit v1.2.3-54-g00ecf