Thread (16 messages) 16 messages, 5 authors, 2025-11-19
STALE221d

[PATCH v2 1/2] doc: git-worktree: Link to examples

From: Michal Suchanek <hidden>
Date: 2025-10-10 17:05:16
Subsystem: documentation, the rest · Maintainers: Jonathan Corbet, Linus Torvalds

Also add advice to put new worktrees outside of existing ones.

Signed-off-by: Michal Suchanek <redacted>
---
v2: Improve formatting
---
 Documentation/git-worktree.adoc | 4 ++++
 1 file changed, 4 insertions(+)
diff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc
index 389e669ac0..a580f4c072 100644
--- a/Documentation/git-worktree.adoc
+++ b/Documentation/git-worktree.adoc
@@ -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
@@ -502,6 +505,7 @@ locked "reason\nwhy is locked"
 ...
 ------------
 
+[[EXAMPLES]]
 EXAMPLES
 --------
 You are in the middle of a refactoring session and your boss comes in and
-- 
2.51.0
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help