summaryrefslogtreecommitdiff
path: root/Documentation/config/worktree.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/config/worktree.adoc')
-rw-r--r--Documentation/config/worktree.adoc19
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/config/worktree.adoc b/Documentation/config/worktree.adoc
new file mode 100644
index 0000000000..5e35c7d018
--- /dev/null
+++ b/Documentation/config/worktree.adoc
@@ -0,0 +1,19 @@
+worktree.guessRemote::
+ If no branch is specified and neither `-b` nor `-B` nor
+ `--detach` is used, then `git worktree add` defaults to
+ creating a new branch from HEAD. If `worktree.guessRemote` is
+ set to true, `worktree add` tries to find a remote-tracking
+ branch whose name uniquely matches the new branch name. If
+ such a branch exists, it is checked out and set as "upstream"
+ for the new branch. If no such match can be found, it falls
+ back to creating a new branch from the current HEAD.
+
+worktree.useRelativePaths::
+ Link worktrees using relative paths (when "true") or absolute
+ paths (when "false"). This is particularly useful for setups
+ where the repository and worktrees may be moved between
+ different locations or environments. Defaults to "false".
++
+Note that setting `worktree.useRelativePaths` to "true" implies enabling the
+`extension.relativeWorktrees` config (see linkgit:git-config[1]),
+thus making it incompatible with older versions of Git.