[PATCH v3 5/6] date: document and test "raw-local" mode
- From
Jeff King <peff@peff.net>
- Date
- Jul 27, 2016, 13:44 UTC
- Message-ID
- <20160727134441.GB14928@sigill.intra.peff.net>
- In-Reply-To
- <5798AA7C.6050107@gmail.com>
On Wed, Jul 27, 2016 at 02:35:08PM +0200, Jakub Narębski wrote:
Show 12 quoted lines
> > All correct. There is no --relative-local because "--relative" is a > > historical artifact. We could support --foo for every --date=foo, but I > > don't think there is a reason to do so (and reasons not to, like > > avoiding cluttering the option space). > > So shouldn't the last sentence > > "The `-local` option has no effect for `--relative`." > > be rather > > "The `-local` option has no effect for `--date=relative`."
Ah, I see. I didn't realize that's what you are getting at. Yes, it would be more accurate. That's not a new problem introduced by my patch; I just happened to be touching that sentence for other reasons. But the patch does try to clean up the text in general, so it seems like a good time to make this fix, too.
Since it looks like this is not even in 'next' yet, here is a replacement for the 5th patch (second from the top) of the jk/reflog-date topic.
-- >8 -- Subject: [PATCH] date: document and test "raw-local" mode
The "raw" format shows a Unix epoch timestamp, but with a timezone tacked on. The timestamp is not _in_ that zone, but it is extra information about the time (by default, the zone the author was in).
The documentation claims that "raw-local" does not work. It does, but the end result is rather subtle. Let's describe it in better detail, and test to make sure it works (namely, the epoch time doesn't change, but the zone does).
While we are rewording the documentation in this area, let's not use the phrase "does not work" for the remaining option, "--date=relative". It's vague; do we accept it or not? We do accept it, but it has no effect (which is a reasonable outcome). We should also refer to the option not as "--relative" (which is the historical synonym, and does not take "-local" at all), but as "--date=relative".
Helped-by: Jakub Narębski <jnareb@gmail.com> Signed-off-by: Jeff King <peff@peff.net> --- Documentation/rev-list-options.txt | 9 ++++++--- t/t0006-date.sh | 1 + 2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 5d1de06..04c7c64 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -725,8 +725,8 @@ include::pretty-options.txt[] `iso-local`), the user's local time zone is used instead. + `--date=relative` shows dates relative to the current time, -e.g. ``2 hours ago''. The `-local` option cannot be used with -`--raw` or `--relative`. +e.g. ``2 hours ago''. The `-local` option has no effect for +`--date=relative`. + `--date=local` is an alias for `--date=default-local`. + @@ -746,7 +746,10 @@ format, often found in email messages. + `--date=short` shows only the date, but not the time, in `YYYY-MM-DD` format. + -`--date=raw` shows the date in the internal raw Git format `%s %z` format. +`--date=raw` shows the date in the internal raw Git format `%s %z` +format. Note that the `-local` option does not affect the +seconds-since-epoch value (which is always measured in UTC), but does +switch the accompanying timezone value. + `--date=format:...` feeds the format `...` to your system `strftime`. Use `--date=format:%c` to show the date in your system locale's diff --git a/t/t0006-date.sh b/t/t0006-date.sh index 4c8cf58..482fec0 100755 --- a/t/t0006-date.sh +++ b/t/t0006-date.sh @@ -47,6 +47,7 @@ check_show short "$TIME" '2016-06-15' check_show default "$TIME" 'Wed Jun 15 16:13:20 2016 +0200' check_show raw "$TIME" '1466000000 +0200' check_show iso-local "$TIME" '2016-06-15 14:13:20 +0000' +check_show raw-local "$TIME" '1466000000 +0000' # arbitrary time absurdly far in the future FUTURE="5758122296 -0400"
-- 2.9.2.607.g98dce7b