Add documentation for git-branch's color configuration.

Benabik · Junio C Hamano · commit f3673988ecb3 · 2007-01-03T08:16:02.000-08:00
Added color.branch and color.branch.&lt;slot&gt; to configuration list.
Style copied from color.status and meanings derived from the code.

Moved the color meanings from color.diff.&lt;slot&gt; to color.branch.&lt;slot&gt;
since the latter comes first alphabetically.

Added --color and --no-color to git-branch's usage and documentation.

Signed-off-by: Brian Gernhardt &lt;benji@silverinsanity.com&gt;
Signed-off-by: Junio C Hamano &lt;junkio@cox.net&gt;
diff --git a/Documentation/config.txt b/Documentation/config.txt
@@ -145,6 +145,21 @@ branch.<name>.merge::
 	this option, `git pull` defaults to merge the first refspec fetched.
 	Specify multiple values to get an octopus merge.
 
+color.branch::
+	A boolean to enable/disable color in the output of
+	gitlink:git-branch[1]. May be set to `true` (or `always`),
+	`false` (or `never`) or `auto`, in which case colors are used
+	only when the output is to a terminal. Defaults to false.
+
+color.branch.<slot>::
+	Use customized color for branch coloration. `<slot>` is one of
+	`current` (the current branch), `local` (a local branch),
+	`remote` (a tracking branch in refs/remotes/), `plain` (other
+	refs), or `reset` (the normal terminal color).  The value for
+	these configuration variables can be one of: `normal`, `bold`,
+	`dim`, `ul`, `blink`, `reverse`, `reset`, `black`, `red`,
+	`green`, `yellow`, `blue`, `magenta`, `cyan`, or `white`.
+
 color.diff::
 	When true (or `always`), always use colors in patch.
 	When false (or `never`), never.  When set to `auto`, use
@@ -155,11 +170,8 @@ color.diff.<slot>::
 	specifies which part of the patch to use the specified
 	color, and is one of `plain` (context text), `meta`
 	(metainformation), `frag` (hunk header), `old` (removed
-	lines), or `new` (added lines).  The value for these
-	configuration variables can be one of: `normal`, `bold`,
-	`dim`, `ul`, `blink`, `reverse`, `reset`, `black`,
-	`red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, or
-	`white`.
+	lines), or `new` (added lines).  The values of these
+	variables may be specified as in color.branch.<slot>.
 
 color.pager::
 	A boolean to enable/disable colored output when the pager is in
@@ -177,7 +189,7 @@ color.status.<slot>::
 	`added` or `updated` (files which are added but not committed),
 	`changed` (files which are changed but not added in the index),
 	or `untracked` (files which are not tracked by git). The values of
-	these variables may be specified as in color.diff.<slot>.
+	these variables may be specified as in color.branch.<slot>.
 
 diff.renameLimit::
 	The number of files to consider when performing the copy/rename
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
@@ -8,7 +8,7 @@ git-branch - List, create, or delete branches.
 SYNOPSIS
 --------
 [verse]
-'git-branch' [-r | -a] [-v [--abbrev=<length>]]
+'git-branch' [--color | --no-color] [-r | -a] [-v [--abbrev=<length>]]
 'git-branch' [-l] [-f] <branchname> [<start-point>]
 'git-branch' (-m | -M) [<oldbranch>] <newbranch>
 'git-branch' (-d | -D) [-r] <branchname>...
@@ -60,6 +60,13 @@ OPTIONS
 -M::
 	Move/rename a branch even if the new branchname already exists.
 
+--color::
+	Color branches to highlight current, local, and remote branches.
+
+--no-color::
+	Turn off branch colors, even when the configuration file gives the
+	default to color output.
+
 -r::
 	List or delete (if used with -d) the remote-tracking branches.
 
diff --git a/builtin-branch.c b/builtin-branch.c
@@ -12,7 +12,7 @@
 #include "builtin.h"
 
 static const char builtin_branch_usage[] =
-  "git-branch [-r] (-d | -D) <branchname> | [-l] [-f] <branchname> [<start-point>] | (-m | -M) [<oldbranch>] <newbranch> | [-r | -a] [-v [--abbrev=<length>]]";
+  "git-branch [-r] (-d | -D) <branchname> | [-l] [-f] <branchname> [<start-point>] | (-m | -M) [<oldbranch>] <newbranch> | [--color | --no-color] [-r | -a] [-v [--abbrev=<length>]]";
 
 #define REF_UNKNOWN_TYPE    0x00
 #define REF_LOCAL_BRANCH    0x01
