]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: git-worktree: Link to examples
authorMichal Suchanek <msuchanek@suse.de>
Thu, 2 Oct 2025 15:51:34 +0000 (17:51 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 2 Oct 2025 17:44:15 +0000 (10:44 -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..4f4d05d61799a6e7a993f47690ec276e23592797 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>>
++
 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,8 +501,8 @@ locked "reason\nwhy is locked"
 ...
 ------------
 
-EXAMPLES
---------
+[[EXAMPLES]]EXAMPLES
+--------------------
 You are in the middle of a refactoring session and your boss comes in and
 demands that you fix something immediately. You might typically use
 linkgit:git-stash[1] to store your changes away temporarily, however, your