log: document the --decorate=auto option

Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 0a4d22aaf7ccf57ec67cd342898977e24d2185a8..cbbb524b63c9d7aa28cf67b200bf1ccfb0380d7d 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -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.
        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.
 
 log.showroot::
        If true, the initial commit will be shown as a big creation event.

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 1f7bc67d6cc8a842151fc2e4705ecc4e6fb8392e..9a9f67c8b07b67535989bdff95773142d16eba58 100644 (file)
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -29,12 +29,14 @@ OPTIONS
        (works only for a single file).
 
 --no-decorate::
        (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
        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
 
 --source::
        Print out the ref name given on the command line by which each