From: "Tao Klerks via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Tao Klerks <tao@klerks.biz>, Tao Klerks <tao@klerks.biz>
Subject: [PATCH] rev-parse: documentation adjustment - mention remote tracking with @{u}
Date: Mon, 20 Jun 2022 04:01:11 +0000 [thread overview]
Message-ID: <pull.1265.git.1655697671724.gitgitgadget@gmail.com> (raw)
From: Tao Klerks <tao@klerks.biz>
The documentation explained the conversion from remote branch path to
local tracking ref path for @{push}, but not for @{upstream}.
Add the note to @{upstream}, and reference it in @{push} to avoid undue
repetition.
Signed-off-by: Tao Klerks <tao@klerks.biz>
---
rev-parse: documentation adjustment - mention remote tracking with @{u}
Small clarification in the doc for git rev-parse.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1265%2FTaoK%2Ftao-upstreak-doc-fix-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1265/TaoK/tao-upstreak-doc-fix-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1265
Documentation/revisions.txt | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index f5f17b65a12..33809036f04 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -97,18 +97,19 @@ some output processing may assume ref names in UTF-8.
'[<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 (configured with `branch.<name>.remote` and
- `branch.<name>.merge`). A missing branchname defaults to the
- current one. These suffixes are also accepted when spelled in uppercase, and
- they mean the same thing no matter the case.
+ refers to the remote branch that the branch specified by branchname
+ is set to build on top of (configured with `branch.<name>.remote` and
+ `branch.<name>.merge`). As `branch.<name>.merge` is the branch path on the
+ remote, it is first converted to a local tracking branch (i.e., something in
+ `refs/remotes/`). A missing branchname defaults to the current one. These
+ suffixes are also accepted when spelled in uppercase, and they mean the same
+ thing no matter the case.
'[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
The suffix '@\{push}' reports the branch "where we would push to" if
`git push` were run while `branchname` was checked out (or the current
- `HEAD` if no branchname is specified). Since our push destination is
- in a remote repository, of course, we report the local tracking branch
- that corresponds to that branch (i.e., something in `refs/remotes/`).
+ `HEAD` if no branchname is specified). Like for '@\{upstream\}', we report
+ the local tracking branch that corresponds to that remote branch.
+
Here's an example to make it more clear:
+
base-commit: 5b71c59bc3b9365075e2a175aa7b6f2b0c84ce44
--
gitgitgadget
next reply other threads:[~2022-06-20 4:01 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-20 4:01 Tao Klerks via GitGitGadget [this message]
2022-06-21 16:19 ` [PATCH] rev-parse: documentation adjustment - mention remote tracking with @{u} Junio C Hamano
2022-06-23 4:37 ` Tao Klerks
2022-06-23 5:01 ` [PATCH v2] " Tao Klerks via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1265.git.1655697671724.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=tao@klerks.biz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).