diff options
author | Jeff King <peff@peff.net> | 2019-03-05 04:20:51 (GMT) |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-03-07 03:48:35 (GMT) |
commit | cd8e7593b9c881996a04858a3329e8ed9f1d4dbc (patch) | |
tree | 3637aefc1ea9857377997b406b4d7375ab55c039 | |
parent | 0d0ac3826a3bbb9247e39e12623bbcfdd722f24c (diff) | |
download | git-cd8e7593b9c881996a04858a3329e8ed9f1d4dbc.zip git-cd8e7593b9c881996a04858a3329e8ed9f1d4dbc.tar.gz git-cd8e7593b9c881996a04858a3329e8ed9f1d4dbc.tar.bz2 |
config: document --type=color output is a complete line
Even though the newer "--type=color" option to "git config" is meant
to be upward compatible with the traditional "--get-color" option,
unlike the latter, its output is not an incomplete line that lack
the LF at the end. That makes it consistent with output of other
types like "git config --type=bool".
Document it, as it sometimes surprises unsuspecting users.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r-- | Documentation/git-config.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 1bfe9f5..d0b9c50 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -240,7 +240,9 @@ Valid `<type>`'s include: output. The optional `default` parameter is used instead, if there is no color configured for `name`. + -`--type=color [--default=<default>]` is preferred over `--get-color`. +`--type=color [--default=<default>]` is preferred over `--get-color` +(but note that `--get-color` will omit the trailing newline printed by +`--type=color`). -e:: --edit:: |