rev-parse: clarify documentation of $name@{upstream} syntax
"git rev-parse" interprets string in string@{upstream} as a name of a branch not a ref. For example, refs/heads/master@{upstream} looks for an upstream branch that is merged by git-pull to ref refs/heads/refs/heads/master not to refs/heads/master. However the documentation could mislead a user to believe that the string is interpreted as ref. Signed-off-by: Kacper Kornet <draenog@pld-linux.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Kacper Kornet committed
Mar 16, 2013 at 19:51 UTC
47e329ef7c46de8ccdc8c4e40333579264a83c21
1 file changed
+4
-4
Documentation/revisions.txt
+4
-4
@@ -88,10 +88,10 @@ some output processing may assume ref names in UTF-8.
88
The construct '@\{-<n>\}' means the <n>th branch checked out
89
before the current one.
90
91
-'<refname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
92
- The suffix '@\{upstream\}' to a ref (short form '<refname>@\{u\}') refers to
93
- the branch the ref is set to build on top of. A missing ref defaults
94
- to the current branch.
91
+'<branchname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
92
+ The suffix '@\{upstream\}' to a branchname (short form '<branchname>@\{u\}')
93
+ refers to the branch that the branch specified by branchname is set to build on
94
+ top of. A missing branchname defaults to the current one.
95
96
'<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
97
A suffix '{caret}' to a revision parameter means the first parent of