Skip to content

Commit 5b67f9a

Browse files
committed
Merge branch 'rj/log-decorate-auto'
We forgot to add "git log --decorate=auto" to documentation when we added the feature back in v2.1.0 timeframe. * rj/log-decorate-auto: log: document the --decorate=auto option
2 parents 3a79d42 + 462cbb4 commit 5b67f9a

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
@@ -1956,7 +1956,10 @@ log.decorate::
19561956
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
19571957
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
19581958
specified, the full ref name (including prefix) will be printed.
1959-
This is the same as the log commands '--decorate' option.
1959+
If 'auto' is specified, then if the output is going to a terminal,
1960+
the ref names are shown as if 'short' were given, otherwise no ref
1961+
names are shown. This is the same as the '--decorate' option
1962+
of the `git log`.
19601963

19611964
log.follow::
19621965
If `true`, `git log` will act as if the `--follow` option was used when

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)