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>
Jeff King committed
Mar 4, 2019 at 23:20 UTC
cd8e7593b9c881996a04858a3329e8ed9f1d4dbc
1 file changed
+3
-1
Documentation/git-config.txt
+3
-1
@@ -240,7 +240,9 @@ Valid `<type>`'s include:
240
output. The optional `default` parameter is used instead, if
241
there is no color configured for `name`.
242
+
243
-`--type=color [--default=<default>]` is preferred over `--get-color`.
243
+`--type=color [--default=<default>]` is preferred over `--get-color`
244
+(but note that `--get-color` will omit the trailing newline printed by
245
+`--type=color`).
246
247
-e::
248
--edit::