aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/revisions.txt
diff options
context:
space:
mode:
authorKacper Kornet <draenog@pld-linux.org>2013-03-16 19:51:43 +0100
committerJunio C Hamano <gitster@pobox.com>2013-03-17 00:10:59 -0700
commit47e329ef7c46de8ccdc8c4e40333579264a83c21 (patch)
tree5a61a0e37d7930a21e153aa0fd010308aecf2dc8 /Documentation/revisions.txt
parentb2981d06226ab0fdabf9110c3be7104110b307ae (diff)
downloadgit-47e329ef7c46de8ccdc8c4e40333579264a83c21.tar.gz
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>
Diffstat (limited to 'Documentation/revisions.txt')
-rw-r--r--Documentation/revisions.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 991fcd8f3f..013f0de798 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 '@\{-<n>\}' means the <n>th branch checked out
before the current one.
-'<refname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
- The suffix '@\{upstream\}' to a ref (short form '<refname>@\{u\}') refers to
- the branch the ref is set to build on top of. A missing ref defaults
- to the current branch.
+'<branchname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
+ The suffix '@\{upstream\}' to a branchname (short form '<branchname>@\{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.
'<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
A suffix '{caret}' to a revision parameter means the first parent of