path: root/Documentation/revisions.txt
diff options
authorJunio C Hamano <>2013-09-17 18:42:51 (GMT)
committerJunio C Hamano <>2013-09-17 18:42:51 (GMT)
commit89dde7882f71f846ccd0359756d27bebc31108de (patch)
tree84e3b55dae79ab5a867983229f33dcb2964dea68 /Documentation/revisions.txt
parentcd8c891b7403754cc7f4b5ace0f799adb83d3218 (diff)
parent4b6acde54364d9350779eb470a1677aa78ed5bf4 (diff)
Merge branch 'rh/ishes-doc'
We liberally use "committish" and "commit-ish" (and "treeish" and "tree-ish"); as these are non-words, let's unify these terms to their dashed form. More importantly, clarify the documentation on object peeling using these terms. * rh/ishes-doc: glossary: fix and clarify the definition of 'ref' revisions.txt: fix and clarify <rev>^{<type>} glossary: more precise definition of tree-ish (a.k.a. treeish) use 'commit-ish' instead of 'committish' use 'tree-ish' instead of 'treeish' glossary: define commit-ish (a.k.a. committish) glossary: mention 'treeish' as an alternative to 'tree-ish'
Diffstat (limited to 'Documentation/revisions.txt')
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index d477b3f..b0f4284 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -111,10 +111,14 @@ some output processing may assume ref names in UTF-8.
'<rev>{caret}\{<type>\}', 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). '<rev>{caret}0'
+ brace pair means dereference the object at '<rev>' recursively until
+ an object of type '<type>' is found or the object cannot be
+ dereferenced anymore (in which case, barf).
+ For example, if '<rev>' is a commit-ish, '<rev>{caret}\{commit\}'
+ describes the corresponding commit object.
+ Similarly, if '<rev>' is a tree-ish, '<rev>{caret}\{tree\}'
+ describes the corresponding tree object.
+ '<rev>{caret}0'
is a short-hand for '<rev>{caret}\{commit\}'.
'rev{caret}\{object\}' can be used to make sure 'rev' names an