diff options
| author | Junio C Hamano <gitster@pobox.com> | 2011-05-06 10:49:53 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-05-06 10:49:53 -0700 |
| commit | 12b99a3598bddfb26efd188ffac6f0e283f02d5a (patch) | |
| tree | a0f29d790c353c744bf812b9b306dc03e8921856 /Documentation/config.txt | |
| parent | ef6b43a44b5e25afe6eee32fcfda7d2a738cec3c (diff) | |
| parent | 6999c54029b42ea996c2fff4fa37303f79b9d8c2 (diff) | |
| download | git-12b99a3598bddfb26efd188ffac6f0e283f02d5a.tar.gz | |
Merge branch 'mg/diff-uiconfig-doc'
* mg/diff-uiconfig-doc:
config.txt,diff-options.txt: porcelain vs. plumbing for color.diff
Diffstat (limited to 'Documentation/config.txt')
| -rw-r--r-- | Documentation/config.txt | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 480dd0a861..0c0f54c30e 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -706,9 +706,16 @@ second is the background. The position of the attribute, if any, doesn't matter. color.diff:: - When set to `always`, always use colors in patch. - When false (or `never`), never. When set to `true` or `auto`, use - colors only when the output is to the terminal. Defaults to false. + Whether to use ANSI escape sequences to add color to patches. + If this is set to `always`, linkgit:git-diff[1], + linkgit:git-log[1], and linkgit:git-show[1] will use color + for all patches. If it is set to `true` or `auto`, those + commands will only use color when output is to the terminal. + Defaults to false. ++ +This does not affect linkgit:git-format-patch[1] nor the +'git-diff-{asterisk}' plumbing commands. Can be overridden on the +command line with the `--color[=<when>]` option. color.diff.<slot>:: Use customized color for diff colorization. `<slot>` specifies @@ -794,11 +801,15 @@ color.status.<slot>:: color.branch.<slot>. color.ui:: - When set to `always`, always use colors in all git commands which - are capable of colored output. When false (or `never`), never. When - set to `true` or `auto`, use colors only when the output is to the - terminal. When more specific variables of color.* are set, they always - take precedence over this setting. Defaults to false. + This variable determines the default value for variables such + as `color.diff` and `color.grep` that control the use of color + per command family. Its scope will expand as more commands learn + configuration to set a default for the `--color` option. Set it + to `always` if you want all output not intended for machine + consumption to use color, to `true` or `auto` if you want such + output to use color when written to the terminal, or to `false` or + `never` if you prefer git commands not to use color unless enabled + explicitly with some other configuration or the `--color` option. commit.status:: A boolean to enable/disable inclusion of status information in the |