[PATCH v1] config/branch: state that <name>.merge is the remote ref
- From
Philip Oakley <philipoakley@iee.email>
- Date
- Oct 16, 2019, 11:28 UTC
- Message-ID
- <20191016112822.1701-1-philipoakley@iee.email>
The branch.<name>.merge value typically looks just like a local ref. Tell the reader it is the ref name at the remote, which may be different.
Signed-off-by: Philip Oakley <philipoakley@iee.email> ---
This confusion had me scratching my head for many minutes recently. A simple clarification would avoid such mental model errors.
Documentation/config/branch.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.txt index a592d522a7..3bfe4f81d3 100644 --- a/Documentation/config/branch.txt +++ b/Documentation/config/branch.txt @@ -53,7 +53,9 @@ branch.<name>.pushRemote:: branch.<name>.merge:: Defines, together with branch.<name>.remote, the upstream branch - for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which + for the given branch. It defines the branch name _on the remote_, + which may be different from the local branch name. + It tells 'git fetch'/'git pull'/'git rebase' which branch to merge and can also affect 'git push' (see push.default). When in branch <name>, it tells 'git fetch' the default refspec to be marked for merging in FETCH_HEAD. The value is
-- 2.23.0.windows.1.21.g947f504ebe8.dirty