Skip to content

Commit 462cbb4

Browse files
ramsay-jonesgitster
authored andcommitted
log: document the --decorate=auto option
Signed-off-by: Ramsay Jones <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3c84ac8 commit 462cbb4

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

Documentation/config.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1699,7 +1699,10 @@ log.decorate::
16991699
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
17001700
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
17011701
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`.
17031706

17041707
log.showroot::
17051708
If true, the initial commit will be shown as a big creation event.

Documentation/git-log.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,14 @@ OPTIONS
2929
(works only for a single file).
3030

3131
--no-decorate::
32-
--decorate[=short|full|no]::
32+
--decorate[=short|full|auto|no]::
3333
Print out the ref names of any commits that are shown. If 'short' is
3434
specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
3535
'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'.
3840

3941
--source::
4042
Print out the ref name given on the command line by which each

0 commit comments

Comments
 (0)