Skip to content

Commit dd4271e

Browse files
hramrachgitster
authored andcommitted
doc: git-worktree: Link to examples
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>
1 parent c44beea commit dd4271e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Documentation/git-worktree.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ with a matching name, treat as equivalent to:
7979
$ git worktree add --track -b <branch> <path> <remote>/<branch>
8080
------------
8181
+
82+
For best results it is advised to specify _<path>_ outside of the repository
83+
and existing worktrees - see <<EXAMPLES,EXAMPLES>>
84+
+
8285
If the branch exists in multiple remotes and one of them is named by
8386
the `checkout.defaultRemote` configuration variable, we'll use that
8487
one for the purposes of disambiguation, even if the `<branch>` isn't
@@ -498,6 +501,7 @@ locked "reason\nwhy is locked"
498501
...
499502
------------
500503

504+
[[EXAMPLES]]
501505
EXAMPLES
502506
--------
503507
You are in the middle of a refactoring session and your boss comes in and

0 commit comments

Comments
 (0)