Documentation: show-branch.

Describe showbranch.default configuration item and give an example.

Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 5b76f3b99e2f3a9d0ecc9357117baa1491d4879e..9cc44a816123ef79e2e5b740bad7615992ced7cd 100644 (file)
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -18,6 +18,9 @@ and/or $GIT_DIR/refs/tags) semi-visually.
 
 It cannot show more than 29 branches and commits at a time.
 
 
 It cannot show more than 29 branches and commits at a time.
 

+It uses `showbranch.default` multi-valued configuration items if
+no <rev> nor <glob> is given on the command line.
+

 
 OPTIONS
 -------
 
 OPTIONS
 -------


@@ -50,7 +53,7 @@ OPTIONS
        tree.
 
 --list::
        tree.
 
 --list::

-       Synomym to `--more=-1`
+       Synonym to `--more=-1`

 
 --merge-base::
        Instead of showing the commit list, just act like the
 
 --merge-base::
        Instead of showing the commit list, just act like the


@@ -115,6 +118,25 @@ adds one commit 'Introduce "reset type"'.  "mhf" branch has many
 other commits.
 
 
 other commits.
 
 

+EXAMPLE
+-------
+
+If you keep your primary branches immediately under
+`$GIT_DIR/refs/heads`, and topic branches in subdirectories of
+it, having the following in the configuration file may help:
+
+------------
+[showbranch]
+       default = --topo-order
+       default = heads/*
+
+------------
+
+With this,`git show-branch` without extra parameters would show
+only the primary branches.
+
+
+

 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>
 Author
 ------
 Written by Junio C Hamano <junkio@cox.net>