[v2] config/branch: state that <name>.merge is the remote ref
diff mbox series

Message ID 20191018205935.2529-1-philipoakley@iee.email
State New
Headers show
Series
  • [v2] config/branch: state that <name>.merge is the remote ref
Related show

Commit Message

Philip Oakley Oct. 18, 2019, 8:59 p.m. UTC
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>
---
 Documentation/config/branch.txt | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Patch
diff mbox series

diff --git a/Documentation/config/branch.txt b/Documentation/config/branch.txt
index a592d522a7..cdc19edaaf 100644
--- a/Documentation/config/branch.txt
+++ b/Documentation/config/branch.txt
@@ -52,8 +52,10 @@  branch.<name>.pushRemote::
 	option to override it for a specific branch.
 
 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
+	The name of the branch ref at the remote `branch.<name>.remote`
+	that is used as the upstream branch for the given 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