diff mbox series

[v3] rev-list: clarify git-log default date format

Message ID xmqqzg9dshei.fsf_-_@gitster.g (mailing list archive)
State Accepted
Commit 9deef088aec321e72955d6ededc9c9f62f083851
Headers show
Series [v3] rev-list: clarify git-log default date format | expand

Commit Message

Junio C Hamano Feb. 16, 2023, 4:29 p.m. UTC
The documentation mistakenly said that the default format was
similar to RFC 2822 format and tried to specify it by enumerating
differences, which had two problems:

 * There are some more differences from the 2822 format that are not
   mentioned; worse yet

 * The default format is not modeled after RFC 2822 format at all.
   As can be seen in f80cd783 (date.c: add "show_date()" function.,
   2005-05-06), it is a derivative of ctime(3) format.

Stop saying that it is similar to RFC 2822, and rewrite the
description to explain the format without requiring the reader to
know any other format.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 * The same text as the previous one; only to correct the lack of
   "--" at the end in v2 that broke the formatting toolchain.

 Documentation/rev-list-options.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Jeff King Feb. 16, 2023, 5:24 p.m. UTC | #1
On Thu, Feb 16, 2023 at 08:29:25AM -0800, Junio C Hamano wrote:

>  * The same text as the previous one; only to correct the lack of
>    "--" at the end in v2 that broke the formatting toolchain.

Thanks. I looked at this version under doc-diff as well as the HTML
version and confirmed that it looks good (which I'm sure you also did at
this point ;) ).

-Peff
diff mbox series

Patch

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index ff68e48406..0d90d5b154 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -1100,12 +1100,12 @@  preferred format.  See the `strftime` manual for a complete list of
 format placeholders. When using `-local`, the correct syntax is
 `--date=format-local:...`.
 
-`--date=default` is the default format, and is similar to
-`--date=rfc2822`, with a few exceptions:
+`--date=default` is the default format, and is based on ctime(3)
+output.  It shows a single line with three-letter day of the week,
+three-letter month, day-of-month, hour-minute-seconds in "HH:MM:SS"
+format, followed by 4-digit year, plus timezone information, unless
+the local time zone is used, e.g. `Thu Jan 1 00:00:00 1970 +0000`.
 --
-	- there is no comma after the day-of-week
-
-	- the time zone is omitted when the local time zone is used
 
 ifdef::git-rev-list[]
 --header::