From c29a721a68e3ce0d1cd9ed8c4ecdb9b32ccd82fb Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 4 Jun 2012 08:15:16 -0700
Subject: documentation/kernel-manual/kernel-how-to.xml: Updates to showing
 changes

I updated the "Show a Particular Feature or Branch Change" section so
that it reads better.  I also included some real examples.

(From yocto-docs rev: 42aa13c7fbf45abf869b056deec063be6682c70b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/kernel-manual/kernel-how-to.xml | 35 +++++++++++++++------------
 1 file changed, 19 insertions(+), 16 deletions(-)

(limited to 'documentation/kernel-manual/kernel-how-to.xml')

diff --git a/documentation/kernel-manual/kernel-how-to.xml b/documentation/kernel-manual/kernel-how-to.xml
index 24da31edcb..2d7f1df97e 100644
--- a/documentation/kernel-manual/kernel-how-to.xml
+++ b/documentation/kernel-manual/kernel-how-to.xml
@@ -308,32 +308,35 @@
                 <title>Show a Particular Feature or Branch Change</title>
 
                 <para>
-                    Significant features or branches are tagged in the Yocto Project tree to divide
-                    changes. 
-                    Remember to first determine (or add) the tag of interest.  
+                    Developers use tags in the Yocto Project tree to divide changes for significant 
+                    features or branches. 
+                    Once you know a particular tag, you can use Git commands 
+                    to show changes associated with the tag and find the branches that contain
+                    the feature.  
                     <note>
                         Because BSP branch, <filename>kernel.org</filename>, and feature tags are all 
                         present, there could be many tags.
                     </note>
+                    The <filename>git show &lt;tag&gt;</filename> command shows changes that are tagged by 
+                    a feature.
+                    Here is an example that shows changes tagged by the <filename>systemtap</filename>
+                    feature:
                     <literallayout class='monospaced'>
-     # show the changes tagged by a feature
-     &gt; git show &lt;tag&gt; 
-        &gt; eg: git show yaffs2
-
-     # determine which branches contain a feature
-     &gt; git branch --contains &lt;tag&gt;
-
-     # show the changes in a kernel type
-     &gt; git whatchanged yocto/base..&lt;kernel type&gt;
-        &gt; eg: git whatchanged yocto/base..yocto/standard/base
+     $ git show systemtap
+                    </literallayout>
+                    You can use the <filename>git branch --contains &lt;tag&gt;</filename> command
+                    to show the branches that contain a particular feature.
+                    This command shows the branches that contain the <filename>systemtap</filename>
+                    feature:
+                    <literallayout class='monospaced'>
+     $ git branch --contains systemtap
                     </literallayout>
                 </para>
 
                 <para>
-                    You can use many other comparisons to isolate BSP changes.
+                    You can use many other comparisons to isolate BSP and kernel changes.
                     For example, you can compare against <filename>kernel.org</filename> tags 
-                    (e.g. v2.6.27.18, etc), or
-                    you can compare against subsystems (e.g. <filename>git whatchanged mm</filename>).
+                    such as the <filename>v3.4</filename> tag.
                 </para>
             </section>
         </section>
-- 
cgit v1.2.3-54-g00ecf