Document what the stage numbers in the :$n:path syntax mean.
The git-rev-parse manpage talks about the :$n:path notation (buried deep in a list of other syntax) but it just says $n is a "stage number" -- someone who is not familiar with the internals of git's merge implementation is never going to be able to figure out that "1", "2", and "3" means. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Steven Grimm committed
Aug 20, 2007 at 11:36 UTC
257a84d9d02e90447b149af58b271c19405edb6a
1 file changed
+4
-1
Documentation/git-rev-parse.txt
+4
-1
@@ -215,7 +215,10 @@ blobs contained in a commit.
215
* A colon, optionally followed by a stage number (0 to 3) and a
216
colon, followed by a path; this names a blob object in the
217
index at the given path. Missing stage number (and the colon
218
- that follows it) names an stage 0 entry.
218
+ that follows it) names an stage 0 entry. During a merge, stage
219
+ 1 is the common ancestor, stage 2 is the target branch's version
220
+ (typically the current branch), and stage 3 is the version from
221
+ the branch being merged.
222
223
Here is an illustration, by Jon Loeliger. Both node B and C are
224
a commit parents of commit node A. Parent commits are ordered