[PATCH 1/5] doc/rev-list-options: clarify "commit@{Nth}" for "-g" option
- From
Jeff King <peff@peff.net>
- Date
- Jul 11, 2016, 05:03 UTC
- Message-ID
- <20160711050327.GA32514@sigill.intra.peff.net>
- In-Reply-To
- <20160711050201.GA18031@sigill.intra.peff.net>
When "log -g" shows "HEAD@{1}", "HEAD@{2}", etc, calling that "commit@{Nth}" is not really accurate. The "HEAD" part is really the refname. By saying "commit", a reader may misunderstand that to mean something related to the specific commit we are showing, not the ref whose reflog we are traversing.
While we're here, let's also switch these instances to use literal backticks, as our style guide recommends. As a bonus, that lets us drop some asciidoc quoting.
Signed-off-by: Jeff King <peff@peff.net> --- Documentation/rev-list-options.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index 4f009d4..6720ff3 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -252,9 +252,9 @@ 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, 'commit@\{Nth}' notation is +taken from the reflog. By default, `ref@{Nth}` notation is used in the output. When the starting commit is specified as -'commit@\{now}', output also uses 'commit@\{timestamp}' notation +`ref@{now}`, output also uses `ref@{timestamp}` notation instead. Under `--pretty=oneline`, the commit message is prefixed with this information on the same line. This option cannot be combined with `--reverse`.
-- 2.9.0.406.g77f030d