Document date formats accepted by parse_date()
authorMiklos Vajna <vmiklos@frugalware.org>
Wed, 2 Dec 2009 23:49:19 +0000 (00:49 +0100)
committerJunio C Hamano <gitster@pobox.com>
Thu, 3 Dec 2009 20:41:37 +0000 (12:41 -0800)
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/date-formats.txt [new file with mode: 0644]
Documentation/git-commit-tree.txt
Documentation/git-commit.txt
diff --git a/Documentation/date-formats.txt b/Documentation/date-formats.txt
new file mode 100644 (file)
index 0000000..c000f08
--- /dev/null
@@ -0,0 +1,26 @@
+DATE FORMATS
+------------
+
+The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
+ifdef::git-commit[]
+and the `--date` option
+endif::git-commit[]
+support the following date formats:
+
+Git internal format::
+       It is `<unix timestamp> <timezone offset>`, where `<unix
+       timestamp>` is the number of seconds since the UNIX epoch.
+       `<timezone offset>` is a positive or negative offset from UTC.
+       For example CET (which is 2 hours ahead UTC) is `+0200`.
+
+RFC 2822::
+       The standard email format as described by RFC 2822, for example
+       `Thu, 07 Apr 2005 22:13:13 +0200`.
+
+ISO 8601::
+       Time and date specified by the ISO 8601 standard, for example
+       `2005-04-07T22:13:13`. The parser accepts a space instead of the
+       `T` character as well.
++
+NOTE: In addition, the date part is accepted in the following formats:
+`YYYY.MM.DD`, `MM/DD/YYYY` and `DD.MM.YYYY`.
index b8834baced4b25d6df47eb578c4d745d23e8cc73..4fec5d5e3869d1f963c935534799c22fc52c46a8 100644 (file)
@@ -73,6 +73,7 @@ A commit comment is read from stdin. If a changelog
 entry is not provided via "<" redirection, 'git-commit-tree' will just wait
 for one to be entered and terminated with ^D.
 
 entry is not provided via "<" redirection, 'git-commit-tree' will just wait
 for one to be entered and terminated with ^D.
 
+include::date-formats.txt[]
 
 Diagnostics
 -----------
 
 Diagnostics
 -----------
index c37c21e4e3e5ced40fbbd7675bd41f8da7454de5..de3435d39780278d974a8ac929873e69b21c67af 100644 (file)
@@ -220,6 +220,8 @@ specified.
        these files are also staged for the next commit on top
        of what have been staged before.
 
        these files are also staged for the next commit on top
        of what have been staged before.
 
+:git-commit: 1
+include::date-formats.txt[]
 
 EXAMPLES
 --------
 
 EXAMPLES
 --------