From f3673988ecb3d3174f9b6d3d04f00774b1b5c261 Mon Sep 17 00:00:00 2001 From: Brian Gernhardt Date: Wed, 3 Jan 2007 10:36:29 -0500 Subject: [PATCH] Add documentation for git-branch's color configuration. Added color.branch and color.branch. to configuration list. Style copied from color.status and meanings derived from the code. Moved the color meanings from color.diff. to color.branch. since the latter comes first alphabetically. Added --color and --no-color to git-branch's usage and documentation. Signed-off-by: Brian Gernhardt Signed-off-by: Junio C Hamano --- Documentation/config.txt | 24 ++++++++++++++++++------ Documentation/git-branch.txt | 9 ++++++++- builtin-branch.c | 2 +- 3 files changed, 27 insertions(+), 8 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 2f4fc2525..4318bf933 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -145,6 +145,21 @@ branch..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.:: + Use customized color for branch coloration. `` 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.:: 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.. color.pager:: A boolean to enable/disable colored output when the pager is in @@ -177,7 +189,7 @@ color.status.:: `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.. + these variables may be specified as in color.branch.. 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 index c464bd2fd..e872fc89f 100644 --- 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=]] +'git-branch' [--color | --no-color] [-r | -a] [-v [--abbrev=]] 'git-branch' [-l] [-f] [] 'git-branch' (-m | -M) [] 'git-branch' (-d | -D) [-r] ... @@ -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 index 745ee04d6..1ed0fa906 100644 --- 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) | [-l] [-f] [] | (-m | -M) [] | [-r | -a] [-v [--abbrev=]]"; + "git-branch [-r] (-d | -D) | [-l] [-f] [] | (-m | -M) [] | [--color | --no-color] [-r | -a] [-v [--abbrev=]]"; #define REF_UNKNOWN_TYPE 0x00 #define REF_LOCAL_BRANCH 0x01 -- 2.30.2