{"thread":{"id":"42470","subject":"[PATCH] log: document the --decorate=auto option","startedAt":"2016-05-27T15:56:02Z","lastAt":"2016-05-27T20:17:36Z","messageCount":3,"participants":["Ramsay Jones","Marc Branchaud","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"287685","messageId":"57486E12.7030907@ramsayjones.plus.com","threadId":"42470","inReplyTo":null,"subject":"[PATCH] log: document the --decorate=auto option","fromName":"Ramsay Jones","fromEmail":"ramsay@ramsayjones.plus.com","sentAt":"2016-05-27T15:56:02Z","receivedAt":"2016-05-27T15:56:02Z","isPatch":true,"sender":{"key":"ramsay@ramsayjones.plus.com","avatar":"https://avatars.githubusercontent.com/u/33702710?v=4"},"body":"\nSigned-off-by: Ramsay Jones \n---\n\nHi Junio,\n\nWhile reading an email from Linus earlier (RFC: dynamic \"auto\" date formats),\nI noticed that log.decorate was being set to 'auto'. Since I didn't recall\nthat setting (even if it's easy to guess), I went looking for the documentation ...\n\nThis should probably be marked RFC, since I haven't checked that the formatting\nis OK (I don't have the documentation toolchain installed these days).\n\nATB,\nRamsay Jones\n\n Documentation/config.txt | 5 ++++-\n Documentation/git-log.txt | 8 +++++---\n 2 files changed, 9 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 53f00db..0707b3b 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -1956,7 +1956,10 @@ log.decorate::\n \tcommand. If 'short' is specified, the ref name prefixes 'refs/heads/',\n \t'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is\n \tspecified, the full ref name (including prefix) will be printed.\n-\tThis is the same as the log commands '--decorate' option.\n+\tIf 'auto' is specified, then if the output is going to a terminal,\n+\tthe ref names are shown as if 'short' were given, otherwise no ref\n+\tnames are shown. This is the same as the log commands '--decorate'\n+\toption.\n \n log.follow::\n \tIf `true`, `git log` will act as if the `--follow` option was used when\ndiff --git a/Documentation/git-log.txt b/Documentation/git-log.txt\nindex 03f9580..dec379b 100644\n--- a/Documentation/git-log.txt\n+++ b/Documentation/git-log.txt\n@@ -29,12 +29,14 @@ OPTIONS\n \t(works only for a single file).\n \n --no-decorate::\n---decorate[=short|full|no]::\n+--decorate[=short|full|auto|no]::\n \tPrint out the ref names of any commits that are shown. If 'short' is\n \tspecified, the ref name prefixes 'refs/heads/', 'refs/tags/' and\n \t'refs/remotes/' will not be printed. If 'full' is specified, the\n-\tfull ref name (including prefix) will be printed. The default option\n-\tis 'short'.\n+\tfull ref name (including prefix) will be printed. If 'auto' is\n+\tspecified, then if the output is going to a terminal, the ref names\n+\tare shown as if 'short' were given, otherwise no ref names are\n+\tshown. The default option is 'short'.\n \n --source::\n \tPrint out the ref name given on the command line by which each\n-- \n2.8.0\n"},{"id":"287705","messageId":"57489366.507@xiplink.com","threadId":"42470","inReplyTo":"57486E12.7030907@ramsayjones.plus.com","subject":"Re: [PATCH] log: document the --decorate=auto option","fromName":"Marc Branchaud","fromEmail":"marcnarc@xiplink.com","sentAt":"2016-05-27T18:35:18Z","receivedAt":"2016-05-27T18:35:18Z","isPatch":true,"sender":{"key":"marcnarc@xiplink.com","avatar":"https://avatars.githubusercontent.com/u/14980203?v=4"},"body":"On 2016-05-27 11:56 AM, Ramsay Jones wrote:\n>\n> Signed-off-by: Ramsay Jones \n> ---\n>\n> Hi Junio,\n>\n> While reading an email from Linus earlier (RFC: dynamic \"auto\" date formats),\n> I noticed that log.decorate was being set to 'auto'. Since I didn't recall\n> that setting (even if it's easy to guess), I went looking for the documentation ...\n>\n> This should probably be marked RFC, since I haven't checked that the formatting\n> is OK (I don't have the documentation toolchain installed these days).\n>\n> ATB,\n> Ramsay Jones\n>\n> Documentation/config.txt | 5 ++++-\n> Documentation/git-log.txt | 8 +++++---\n> 2 files changed, 9 insertions(+), 4 deletions(-)\n>\n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> index 53f00db..0707b3b 100644\n> --- a/Documentation/config.txt\n> +++ b/Documentation/config.txt\n> @@ -1956,7 +1956,10 @@ log.decorate::\n> \tcommand. If 'short' is specified, the ref name prefixes 'refs/heads/',\n> \t'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is\n> \tspecified, the full ref name (including prefix) will be printed.\n> -\tThis is the same as the log commands '--decorate' option.\n> +\tIf 'auto' is specified, then if the output is going to a terminal,\n> +\tthe ref names are shown as if 'short' were given, otherwise no ref\n> +\tnames are shown. This is the same as the log commands '--decorate'\n\ns/commands/command's/\n\n\t\tM.\n"},{"id":"287714","messageId":"xmqqy46vp867.fsf@gitster.mtv.corp.google.com","threadId":"42470","inReplyTo":"57489366.507@xiplink.com","subject":"Re: [PATCH] log: document the --decorate=auto option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2016-05-27T20:17:36Z","receivedAt":"2016-05-27T20:17:36Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Thanks, both.\n"}]}