[PATCH] Add documentation for show-branch --topics

From

Brian Gernhardt <benji@silverinsanity.com>

Date

Dec 18, 2006, 15:48 UTC

Message-ID

<20061218154812.GA5716@178.242.249.10.in-addr.arpa>

Signed-off-by: Brian Gernhardt <benji@silverinsanity.com>
---

 git blame helped me find the original description of this feature.
 I'm not sure this is the best explanation possible, but it gives
 both a quick description and a way to figure out what it's doing.
 Which is hopefully better than nothing.

 Documentation/git-show-branch.txt |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index a2445a4..a9a0e0c 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 [verse]
 'git-show-branch' [--all] [--heads] [--tags] [--topo-order] [--current]
 		[--more=<n> | --list | --independent | --merge-base]
-		[--no-name | --sha1-name] [<rev> | <glob>]...
+		[--no-name | --sha1-name] [--topics] [<rev> | <glob>]...
 
 DESCRIPTION
 -----------
@@ -86,6 +86,14 @@ OPTIONS
 	of "master"), name them with the unique prefix of their
 	object names.
 
+--topics::
+	Shows only commits that are NOT on the first branch given.
+	This helps track topic branches by hiding any commit that
+	is already in the main line of development.  When given
+	"git show-branch --topics master topic1 topic2", this
+	will show the revisions given by "git rev-list ^master
+	topic1 topic2"
+
 Note that --more, --list, --independent and --merge-base options
 are mutually exclusive.
 

-- 
1.4.4.1.GIT