Documentation: do not assume that n > 1 in <rev>~$n
authorJunio C Hamano <gitster@pobox.com>
Wed, 29 Feb 2012 19:13:22 +0000 (11:13 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 2 Mar 2012 17:33:29 +0000 (09:33 -0800)
We explained <rev>~<n> as <n>th generation grand-parent, but a reader got
confused by the "grand-" part when <n> is 1.

Reword it with "ancestor"; with the "generation" and "following only the
first parents" around there, what we try to describe should be clear
enough now.

Noticed-by: Luke Diamand <luke@diamand.org>
Helped-by: Thomas Rast <trast@inf.ethz.ch>
Helped-by: Andreas Ericsson <ae@op5.se>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/revisions.txt

index b290b617d4a59ee2ae6b62f2eebd9e86f71c4802..1725661837ad666dc1a06b19162a43f10fe6e13a 100644 (file)
@@ -101,7 +101,7 @@ the '$GIT_DIR/refs' directory or from the '$GIT_DIR/packed-refs' file.
 
 '<rev>{tilde}<n>', e.g. 'master{tilde}3'::
   A suffix '{tilde}<n>' to a revision parameter means the commit
-  object that is the <n>th generation grand-parent of the named
+  object that is the <n>th generation ancestor of the named
   commit object, following only the first parents.  I.e. '<rev>{tilde}3' is
   equivalent to '<rev>{caret}{caret}{caret}' which is equivalent to
   '<rev>{caret}1{caret}1{caret}1'.  See below for an illustration of