1
0
mirror of https://github.com/git/git.git synced 2025-04-18 01:16:07 +00:00

log: document the --decorate=auto option

Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Ramsay Jones 2016-05-27 16:56:02 +01:00 committed by Junio C Hamano
parent 3c84ac86fc
commit 462cbb415e
2 changed files with 9 additions and 4 deletions

@ -1699,7 +1699,10 @@ log.decorate::
command. If 'short' is specified, the ref name prefixes 'refs/heads/',
'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is
specified, the full ref name (including prefix) will be printed.
This is the same as the log commands '--decorate' option.
If 'auto' is specified, then if the output is going to a terminal,
the ref names are shown as if 'short' were given, otherwise no ref
names are shown. This is the same as the '--decorate' option
of the `git log`.
log.showroot::
If true, the initial commit will be shown as a big creation event.

@ -29,12 +29,14 @@ OPTIONS
(works only for a single file).
--no-decorate::
--decorate[=short|full|no]::
--decorate[=short|full|auto|no]::
Print out the ref names of any commits that are shown. If 'short' is
specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
'refs/remotes/' will not be printed. If 'full' is specified, the
full ref name (including prefix) will be printed. The default option
is 'short'.
full ref name (including prefix) will be printed. If 'auto' is
specified, then if the output is going to a terminal, the ref names
are shown as if 'short' were given, otherwise no ref names are
shown. The default option is 'short'.
--source::
Print out the ref name given on the command line by which each