log: document the --decorate=auto option
Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ramsay Jones committed
May 27, 2016 at 16:56 UTC
462cbb415e41aa890e78a30a5cc29558baa80b23
2 files changed
+9
-4
Documentation/config.txt
+4
-1
@@ -1699,7 +1699,10 @@ log.decorate::
1699
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
1700
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
1701
specified, the full ref name (including prefix) will be printed.
1702
- This is the same as the log commands '--decorate' option.
1702
+ If 'auto' is specified, then if the output is going to a terminal,
1703
+ the ref names are shown as if 'short' were given, otherwise no ref
1704
+ names are shown. This is the same as the '--decorate' option
1705
+ of the `git log`.
1706
1707
log.showroot::
1708
If true, the initial commit will be shown as a big creation event.
Documentation/git-log.txt
+5
-3
@@ -29,12 +29,14 @@ OPTIONS
29
(works only for a single file).
30
31
--no-decorate::
32
---decorate[=short|full|no]::
32
+--decorate[=short|full|auto|no]::
33
Print out the ref names of any commits that are shown. If 'short' is
34
specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
35
'refs/remotes/' will not be printed. If 'full' is specified, the
36
- full ref name (including prefix) will be printed. The default option
37
- is 'short'.
36
+ full ref name (including prefix) will be printed. If 'auto' is
37
+ specified, then if the output is going to a terminal, the ref names
38
+ are shown as if 'short' were given, otherwise no ref names are
39
+ shown. The default option is 'short'.
40
41
--source::
42
Print out the ref name given on the command line by which each