Document extended SHA1 used by git-rev-parse.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Junio C Hamano committed
Sep 18, 2005 at 11:13 UTC
3a45f625aef0074a41885f1df335844ec8c04f5e
1 file changed
+34
Documentation/git-rev-parse.txt
+34
@@ -76,6 +76,40 @@ OPTIONS
76
Flags and parameters to be parsed.
77
78
79
+SPECIFYING REVISIONS
80
+--------------------
81
+
82
+A revision parameter typically names a commit object. They use
83
+what is called an 'extended SHA1' syntax.
84
+
85
+* The full SHA1 object name (40-byte hexadecimal string), or
86
+ a substring of such that is unique within the repository.
87
+ E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
88
+ name the same commit object if there are no other object in
89
+ your repository whose object name starts with dae86e.
90
+
91
+* A symbolic ref name. E.g. 'master' typically means the commit
92
+ object referenced by $GIT_DIR/refs/heads/master. If you
93
+ happen to have both heads/master and tags/master, you can
94
+ explicitly say 'heads/master' to tell GIT which one you mean.
95
+
96
+* A suffix '^' to a revision parameter means the first parent of
97
+ that commit object. '^<n>' means the <n>th parent (i.e. 'rev^'
98
+ is equivalent to 'rev^1'). As a special rule,
99
+ 'rev^0' means the commit itself and is used when 'rev' is the
100
+ object name of a tag object that refers to a commit object.
101
+
102
+* A suffix '~<n>' to a revision parameter means the commit
103
+ object that is the <n>th generation grand-parent of the named
104
+ commit object, following only the first parent. I.e. rev~3 is
105
+ equivalent to rev^^^ which is equivalent to rev^1^1^1.
106
+
107
+'git-rev-parse' also accepts a prefix '^' to revision parameter,
108
+which is passed to 'git-rev-list'. Two revision parameters
109
+concatenated with '..' is a short-hand for writing a range
110
+between them. I.e. 'r1..r2' is equivalent to saying '^r1 r2'
111
+
112
+
113
Author
114
------
115
Written by Linus Torvalds <torvalds@osdl.org> and