Skip to content

Commit 6d3824c

Browse files
sunshinecogitster
authored andcommitted
Documentation/git-worktree: add BUGS section
Relocate submodule warning to BUGS and enumerate missing commands. Signed-off-by: Eric Sunshine <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 93a3649 commit 6d3824c

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

Documentation/git-worktree.txt

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,6 @@ to `/path/main/.git/worktrees/test-next` then a file named
7676
`test-next` entry from being pruned. See
7777
linkgit:gitrepository-layout[5] for details.
7878

79-
Multiple checkout support for submodules is incomplete. It is NOT
80-
recommended to make multiple checkouts of a superproject.
81-
8279
COMMANDS
8380
--------
8481
prune::
@@ -100,6 +97,22 @@ OPTIONS
10097
--expire <time>::
10198
With `prune`, only expire unused worktrees older than <time>.
10299

100+
BUGS
101+
----
102+
Multiple checkout support for submodules is incomplete. It is NOT
103+
recommended to make multiple checkouts of a superproject.
104+
105+
git-worktree could provide more automation for tasks currently
106+
performed manually or via other commands, such as:
107+
108+
- `add` to create a new linked worktree
109+
- `remove` to remove a linked worktree and its administrative files (and
110+
warn if the worktree is dirty)
111+
- `mv` to move or rename a worktree and update its administrative files
112+
- `list` to list linked worktrees
113+
- `lock` to prevent automatic pruning of administrative files (for instance,
114+
for a worktree on a portable device)
115+
103116
SEE ALSO
104117
--------
105118

0 commit comments

Comments
 (0)