Document the master@{n} reflog query syntax.
authorShawn O. Pearce <spearce@spearce.org>
Thu, 18 Jan 2007 02:08:04 +0000 (21:08 -0500)
committerJunio C Hamano <junkio@cox.net>
Thu, 18 Jan 2007 04:45:15 +0000 (20:45 -0800)
In ab2a1a32 Junio improved the reflog query logic to support
obtaining the n-th prior value of a ref, but this was never
documented in git-rev-parse.  Now it is.

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/git-rev-parse.txt

index 4eaf5a0d1ea26798298c4f572c29d90af9dc7cf1..aeb37b65d26dbc2873438bd7b2c36bf89d24b056 100644 (file)
@@ -152,6 +152,14 @@ blobs contained in a commit.
   used immediately following a ref name and the ref must have an
   existing log ($GIT_DIR/logs/<ref>).
 
+* A ref followed by the suffix '@' with an ordinal specification
+  enclosed in a brace pair (e.g. '\{1\}', '\{15\}') to specify
+  the n-th prior value of that ref.  For example 'master@\{1\}'
+  is the immediate prior value of 'master' while 'master@\{5\}'
+  is the 5th prior value of 'master'. This suffix may only be used
+  immediately following a ref name and the ref must have an existing
+  log ($GIT_DIR/logs/<ref>).
+
 * A suffix '{caret}' to a revision parameter means the first parent of
   that commit object.  '{caret}<n>' means the <n>th parent (i.e.
   'rev{caret}'