diff options
| author | Ramsay Jones <ramsay@ramsayjones.plus.com> | 2016-05-27 16:56:02 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-05-27 13:16:47 -0700 |
| commit | 462cbb415e41aa890e78a30a5cc29558baa80b23 (patch) | |
| tree | 1515b9c611d9a71785f65f97a66a071ba490befa | |
| parent | 3c84ac86fc896c108b789b8eb26b169cc0e8088a (diff) | |
| download | git-rj/log-decorate-auto.tar.gz | |
log: document the --decorate=auto optionrj/log-decorate-auto
Signed-off-by: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/config.txt | 5 | ||||
| -rw-r--r-- | Documentation/git-log.txt | 8 |
2 files changed, 9 insertions, 4 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 0a4d22aaf7..cbbb524b63 100644 --- 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. - 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. diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 1f7bc67d6c..9a9f67c8b0 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -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 |