]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: git-worktree: Link to examples
authorMichal Suchanek <msuchanek@suse.de>
Fri, 10 Oct 2025 17:04:57 +0000 (19:04 +0200)
committerJunio C Hamano <gitster@pobox.com>
Fri, 10 Oct 2025 18:20:25 +0000 (11:20 -0700)
Also add advice to put new worktrees outside of existing ones.

Signed-off-by: Michal Suchanek <msuchanek@suse.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-worktree.adoc

index 8340b7f028e6c1c3bae3de0879e9754098466d14..05cc8c393311200472eaa51703780397ca944fb4 100644 (file)
@@ -79,6 +79,9 @@ with a matching name, treat as equivalent to:
 $ git worktree add --track -b <branch> <path> <remote>/<branch>
 ------------
 +
+For best results it is advised to specify _<path>_ outside of the repository
+and existing worktrees - see <<EXAMPLES,EXAMPLES>>
++
 If the branch exists in multiple remotes and one of them is named by
 the `checkout.defaultRemote` configuration variable, we'll use that
 one for the purposes of disambiguation, even if the `<branch>` isn't
@@ -498,6 +501,7 @@ locked "reason\nwhy is locked"
 ...
 ------------
 
+[[EXAMPLES]]
 EXAMPLES
 --------
 You are in the middle of a refactoring session and your boss comes in and