Re: [PATCHv3] git-rev-parse.txt: Document ":path" specifier
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jun 27, 2010, 19:29 UTC
- Message-ID
- <7vocewff4b.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <6af64ac563a9a165bec7fddc779b31ae5bcb9997.1277644307.git.git@drmicha.warpmail.net>
Thanks, will replace v2 with this versoin, but I suspect that swapping the two bullets in the existing documentation without anything else may be a simpler and easier-to-read alternative.
Orthogonal to this, it would probably make sense to give a simplest example in-line in the text, i.e.
Documentation/git-rev-parse.txt | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 8db600f..c03f31d 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -291,12 +291,12 @@ the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file. * A suffix ':' followed by a path; this names the blob or tree at the given path in the tree-ish object named by the part - before the colon. + before the colon (e.g. "HEAD:README"). * A colon, optionally followed by a stage number (0 to 3) and a colon, followed by a path; this names a blob object in the - index at the given path. Missing stage number (and the colon - that follows it) names a stage 0 entry. During a merge, stage + index at the given path (e.g. ":0:README"). Missing stage number (and the colon + that follows it) names a stage 0 entry (e.g. ":README"). During a merge, stage 1 is the common ancestor, stage 2 is the target branch's version (typically the current branch), and stage 3 is the version from the branch being merged.