# [PATCH] rev-parse: Clarify documentation of @{upstream} syntax 3 messages from 2013-03-16 to 2013-03-17. Participants: Kacper Kornet, Eric Sunshine. Thread: https://gitlist.dev/t/33202 ## Kacper Kornet, 2013-03-16 18:51 Subject: [PATCH] rev-parse: Clarify documentation of @{upstream} syntax Message-ID: <1363459903-32358-1-git-send-email-draenog@pld-linux.org> URL: https://gitlist.dev/e/1363459903-32358-1-git-send-email-draenog%40pld-linux.org ``` 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 misled a user to believe that the string is interpreted as ref. Signed-off-by: Kacper Kornet --- Documentation/revisions.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt index 678d175..314e25d 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 -- 1.8.2 ``` ## Eric Sunshine, 2013-03-17 04:31 Subject: Re: [PATCH] rev-parse: Clarify documentation of @{upstream} syntax Message-ID: URL: https://gitlist.dev/e/CAPig%2BcTL_u_AV1-E9JhBRP2JP97vod9iWpRtM0SETX9-GL_-2w%40mail.gmail.com In-Reply-To: <1363459903-32358-1-git-send-email-draenog@pld-linux.org> ``` On Sat, Mar 16, 2013 at 2:51 PM, Kacper Kornet wrote: > 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 misled a user to believe that the string is s/misled/mislead/ > interpreted as ref. ``` ## Kacper Kornet, 2013-03-17 22:17 Subject: [PATCH] t1507: Test that branchname@{upstream} is interpreted as branch Message-ID: <20130317221708.GA7707@camk.edu.pl> URL: https://gitlist.dev/e/20130317221708.GA7707%40camk.edu.pl In-Reply-To: <1363459903-32358-1-git-send-email-draenog@pld-linux.org> ``` Syntax branchname@{upstream} should interpret its argument as a name of a branch. Add the test to check that it doesn't try to interpret it as a refname if the branch in question does not exist. Signed-off-by: Kacper Kornet --- Maybe I'm too cautious adding this test. But just in case here it is. t/t1507-rev-parse-upstream.sh | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/t/t1507-rev-parse-upstream.sh b/t/t1507-rev-parse-upstream.sh index d6e5761..b27a720 100755 --- a/t/t1507-rev-parse-upstream.sh +++ b/t/t1507-rev-parse-upstream.sh @@ -54,6 +54,10 @@ test_expect_success 'my-side@{upstream} resolves to correct full name' ' test refs/remotes/origin/side = "$(full_name my-side@{u})" ' +test_expect_success 'refs/heads/my-side@{upstream} does not resolve to my-side{upstream}' ' + test_must_fail full_name refs/heads/my-side@{upstream} +' + test_expect_success 'my-side@{u} resolves to correct commit' ' git checkout side && test_commit 5 && -- 1.8.2 ```