summaryrefslogtreecommitdiff
path: root/Documentation/git-checkout.txt
diff options
context:
space:
mode:
authorJosh Steadmon <steadmon@google.com>2021-12-21 03:30:23 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-12-21 06:40:21 (GMT)
commitd3115660b4cc4b1a32e77ddfd289afde5e4b94d8 (patch)
tree5baeee60cbaafcb23d7ce8ac27941affdd47fdfb /Documentation/git-checkout.txt
parenta3f40ec4b0dc56a54e6a6866d0a44a04d4a6edf0 (diff)
downloadgit-d3115660b4cc4b1a32e77ddfd289afde5e4b94d8.zip
git-d3115660b4cc4b1a32e77ddfd289afde5e4b94d8.tar.gz
git-d3115660b4cc4b1a32e77ddfd289afde5e4b94d8.tar.bz2
branch: add flags and config to inherit tracking
It can be helpful when creating a new branch to use the existing tracking configuration from the branch point. However, there is currently not a method to automatically do so. Teach git-{branch,checkout,switch} an "inherit" argument to the "--track" option. When this is set, creating a new branch will cause the tracking configuration to default to the configuration of the branch point, if set. For example, if branch "main" tracks "origin/main", and we run `git checkout --track=inherit -b feature main`, then branch "feature" will track "origin/main". Thus, `git status` will show us how far ahead/behind we are from origin, and `git pull` will pull from origin. This is particularly useful when creating branches across many submodules, such as with `git submodule foreach ...` (or if running with a patch such as [1], which we use at $job), as it avoids having to manually set tracking info for each submodule. Since we've added an argument to "--track", also add "--track=direct" as another way to explicitly get the original "--track" behavior ("--track" without an argument still works as well). Finally, teach branch.autoSetupMerge a new "inherit" option. When this is set, "--track=inherit" becomes the default behavior. [1]: https://lore.kernel.org/git/20180927221603.148025-1-sbeller@google.com/ Signed-off-by: Josh Steadmon <steadmon@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-checkout.txt')
-rw-r--r--Documentation/git-checkout.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index d473c9b..61825b0 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -156,7 +156,7 @@ of it").
linkgit:git-branch[1] for details.
-t::
---track::
+--track [direct|inherit]::
When creating a new branch, set up "upstream" configuration. See
"--track" in linkgit:git-branch[1] for details.
+