From abdb54a1d26c79692468aaf2c651e85c2a917c15 Mon Sep 17 00:00:00 2001 From: Richard Hansen Date: Wed, 4 Sep 2013 15:04:33 -0400 Subject: revisions.txt: fix and clarify ^{} If possible, will be dereferenced even if it is not a tag type (e.g., commit dereferenced to a tree). Signed-off-by: Richard Hansen Signed-off-by: Junio C Hamano --- Documentation/revisions.txt | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'Documentation/revisions.txt') diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt index d477b3f6bc..b0f4284cfb 100644 --- a/Documentation/revisions.txt +++ b/Documentation/revisions.txt @@ -111,10 +111,14 @@ some output processing may assume ref names in UTF-8. '{caret}\{\}', e.g. 'v0.99.8{caret}\{commit\}':: A suffix '{caret}' followed by an object type name enclosed in - brace pair means the object - could be a tag, and dereference the tag recursively until an - object of that type is found or the object cannot be - dereferenced anymore (in which case, barf). '{caret}0' + brace pair means dereference the object at '' recursively until + an object of type '' is found or the object cannot be + dereferenced anymore (in which case, barf). + For example, if '' is a commit-ish, '{caret}\{commit\}' + describes the corresponding commit object. + Similarly, if '' is a tree-ish, '{caret}\{tree\}' + describes the corresponding tree object. + '{caret}0' is a short-hand for '{caret}\{commit\}'. + 'rev{caret}\{object\}' can be used to make sure 'rev' names an -- cgit v1.2.3