From: Kacper Kornet Date: Sat, 16 Mar 2013 18:51:43 +0000 (+0100) Subject: rev-parse: clarify documentation of $name@{upstream} syntax X-Git-Tag: v1.8.1.6~28 X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=47e329ef7c46de8ccdc8c4e40333579264a83c21;p=git-core%2Fgit.git 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 Signed-off-by: Junio C Hamano --- diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt index 991fcd8f3..013f0de79 100644 --- a/Documentation/revisions.txt +++ b/Documentation/revisions.txt @@ -88,10 +88,10 @@ some output processing may assume ref names in UTF-8. The construct '@\{-\}' means the th branch checked out before the current one. -'@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}':: - The suffix '@\{upstream\}' to a ref (short form '@\{u\}') refers to - the branch the ref is set to build on top of. A missing ref defaults - to the current branch. +'@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}':: + The suffix '@\{upstream\}' to a branchname (short form '@\{u\}') + refers to the branch that the branch specified by branchname is set to build on + top of. A missing branchname defaults to the current one. '{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0':: A suffix '{caret}' to a revision parameter means the first parent of