Documentation/git-worktree: add BUGS section

Relocate submodule warning to BUGS and enumerate missing commands.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 3d288967f3be694a3fc650d6ae9c0544ec47b5db..bf6a1e229c08692bdeaee41ce3cb133ec6663779 100644 (file)
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -76,9 +76,6 @@ to `/path/main/.git/worktrees/test-next` then a file named
 `test-next` entry from being pruned.  See
 linkgit:gitrepository-layout[5] for details.
 
 `test-next` entry from being pruned.  See
 linkgit:gitrepository-layout[5] for details.
 

-Multiple checkout support for submodules is incomplete. It is NOT
-recommended to make multiple checkouts of a superproject.
-

 COMMANDS
 --------
 prune::
 COMMANDS
 --------
 prune::


@@ -100,6 +97,22 @@ OPTIONS
 --expire <time>::
        With `prune`, only expire unused worktrees older than <time>.
 
 --expire <time>::
        With `prune`, only expire unused worktrees older than <time>.
 

+BUGS
+----
+Multiple checkout support for submodules is incomplete. It is NOT
+recommended to make multiple checkouts of a superproject.
+
+git-worktree could provide more automation for tasks currently
+performed manually or via other commands, such as:
+
+- `add` to create a new linked worktree
+- `remove` to remove a linked worktree and its administrative files (and
+  warn if the worktree is dirty)
+- `mv` to move or rename a worktree and update its administrative files
+- `list` to list linked worktrees
+- `lock` to prevent automatic pruning of administrative files (for instance,
+  for a worktree on a portable device)
+

 SEE ALSO
 --------
 
 SEE ALSO
 --------