for-each-ref: document `creatordate` and `creator` fields
These were introduced back in 2006 at 3175aa1ec28c but never documented. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Eric Wong committed
Jan 5, 2016 at 03:51 UTC
e914ef0d03d189611fe02e0fd26f5f964594767e
1 file changed
+7
-2
Documentation/git-for-each-ref.txt
+7
-2
@@ -109,6 +109,11 @@ In addition to the above, for commit and tag objects, the header
109
field names (`tree`, `parent`, `object`, `type`, and `tag`) can
110
be used to specify the value in the header field.
111
112
+For commit and tag objects, the special `creatordate` and `creator`
113
+fields will correspond to the appropriate date or name-email-date tuple
114
+from the `committer` or `tagger` fields depending on the object type.
115
+These are intended for working on a mix of annotated and lightweight tags.
116
+
117
Fields that have name-email-date tuple as its value (`author`,
118
`committer`, and `tagger`) can be suffixed with `name`, `email`,
119
and `date` to extract the named component.
@@ -119,8 +124,8 @@ of all lines of the commit message up to the first blank line. The next
124
line is 'contents:body', where body is all of the lines after the first
125
blank line. Finally, the optional GPG signature is `contents:signature`.
126
122
-For sorting purposes, fields with numeric values sort in numeric
123
-order (`objectsize`, `authordate`, `committerdate`, `taggerdate`).
127
+For sorting purposes, fields with numeric values sort in numeric order
128
+(`objectsize`, `authordate`, `committerdate`, `creatordate`, `taggerdate`).
129
All other fields are used to sort in their byte-value order.
130
131
In any case, a field name that refers to a field inapplicable to