diff options
| author | Jeff King <peff@peff.net> | 2016-07-22 15:51:32 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2016-07-22 13:47:33 -0700 |
| commit | 83c9f95cce99bcd383c78d614d614e72a4015e59 (patch) | |
| tree | 14eb37a3e29b49f48d637562551ef697a9a3d924 | |
| parent | 2b68222d72fcb899ac87d8d48f066b49b5182f28 (diff) | |
| download | git-83c9f95cce99bcd383c78d614d614e72a4015e59.tar.gz | |
doc/rev-list-options: explain "-g" output formats
We document that asking for HEAD@{now} will switch the
output to show HEAD@{timestamp}, but not that specifying
`--date` has a similar effect, or that it can be overridden
with HEAD@{0}. Let's do so.
These rules come from 794151e (reflog-walk: always make
HEAD@{0} show indexed selectors, 2012-05-04), though that is
simply the culmination of years of these heuristics growing
organically.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/rev-list-options.txt | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 6720ff3bbe..5267ee1937 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -252,10 +252,25 @@ list. + With `--pretty` format other than `oneline` (for obvious reasons), this causes the output to have two extra lines of information -taken from the reflog. By default, `ref@{Nth}` notation is -used in the output. When the starting commit is specified as -`ref@{now}`, output also uses `ref@{timestamp}` notation -instead. Under `--pretty=oneline`, the commit message is +taken from the reflog. The reflog designator in the output may be shown +as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the +reflog) or as `ref@{timestamp}` (with the timestamp for that entry), +depending on a few rules: ++ +-- +1. If the starting point is specified as `ref@{Nth}`, show the index +format. ++ +2. If the starting point was specified as `ref@{now}`, show the +timestamp format. ++ +3. If neither was used, but `--date` was given on the command line, show +the timestamp in the format requested by `--date`. ++ +4. Otherwise, show the index format. +-- ++ +Under `--pretty=oneline`, the commit message is prefixed with this information on the same line. This option cannot be combined with `--reverse`. See also linkgit:git-reflog[1]. |