aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/revisions.txt
diff options
context:
space:
mode:
authorTao Klerks <tao@klerks.biz>2022-06-23 05:01:52 +0000
committerJunio C Hamano <gitster@pobox.com>2022-06-23 08:35:09 -0700
commit8cdab69d967ec826ed258e31a26c8cb4720ffdca (patch)
treebbd51954cf0fbcb78ea2d823716fd9474619f2a1 /Documentation/revisions.txt
parentdc8c8deaa6b5847733bd7df011a4c7b7d1a64e0a (diff)
downloadgit-8cdab69d967ec826ed258e31a26c8cb4720ffdca.tar.gz
rev-parse: documentation adjustment - mention remote tracking with @{u}
The documentation explained the conversion from remote branch path to local tracking ref path for @{push}, but not for @{upstream}. Add the explanation to @{upstream}, and reference it in @{push} to avoid undue repetition. Signed-off-by: Tao Klerks <tao@klerks.biz> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/revisions.txt')
-rw-r--r--Documentation/revisions.txt15
1 files changed, 6 insertions, 9 deletions
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index f5f17b65a1..7fcfbcbac7 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -96,19 +96,16 @@ some output processing may assume ref names in UTF-8.
before the current one.
'[<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.
+ A branch B may be set up to build on top of a branch X (configured with
+ `branch.<name>.merge`) at a remote R (configured with
+ `branch.<name>.remote`). B@{u} refers to the remote-tracking branch for
+ the branch X taken from remote R, typically found at `refs/remotes/R/X`.
'[<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 remote-tracking branch that corresponds to that branch at the remote.
+
Here's an example to make it more clear:
+