[PATCH 3/5] Refer to branch.<name>.remote/merge when documenting --track
- From
Johan Herland <johan@herland.net>
- Date
- Sep 6, 2013, 10:40 UTC
- Message-ID
- <1378464042-17476-4-git-send-email-johan@herland.net>
- In-Reply-To
- <1378464042-17476-1-git-send-email-johan@herland.net>
Make it easier for readers to find the actual config variables that implement the "upstream" relationship.
Suggested-by: Per Cederqvist <cederp@opera.com> Signed-off-by: Johan Herland <johan@herland.net> ---
In a private email exchange, Per noted that it was hard for someone reading the git-branch docs to grasp what really happens when you use --track to establish an "upstream" relationship. This adds a couple of references to the config variables involved, and will hopefully make the upstream relationship a little less "magic".
...Johan
Documentation/git-branch.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index b7cb625..311b336 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -48,7 +48,8 @@ working tree to it; use "git checkout <newbranch>" to switch to the new branch. When a local branch is started off a remote-tracking branch, Git sets up the -branch so that 'git pull' will appropriately merge from +branch (specifically the `branch.<name>.remote` and `branch.<name>.merge` +configuration entries) so that 'git pull' will appropriately merge from the remote-tracking branch. This behavior may be changed via the global `branch.autosetupmerge` configuration flag. That setting can be overridden by using the `--track` and `--no-track` options, and @@ -156,7 +157,8 @@ This option is only applicable in non-verbose mode. -t:: --track:: - When creating a new branch, set up configuration to mark the + When creating a new branch, set up `branch.<name>.remote` and + `branch.<name>.merge` configuration entries to mark the start-point branch as "upstream" from the new branch. This configuration will tell git to show the relationship between the two branches in `git status` and `git branch -v`. Furthermore, -- 1.8.3.GIT