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>
Eric Sunshine committed
Jul 6, 2015 at 13:30 UTC
6d3824cf92c14d81ffb2ecaa76e35a811b7f596f
1 file changed
+16
-3
Documentation/git-worktree.txt
+16
-3
@@ -76,9 +76,6 @@ to `/path/main/.git/worktrees/test-next` then a file named
76
`test-next` entry from being pruned. See
77
linkgit:gitrepository-layout[5] for details.
78
79
-Multiple checkout support for submodules is incomplete. It is NOT
80
-recommended to make multiple checkouts of a superproject.
81
-
79
COMMANDS
80
--------
81
prune::
@@ -100,6 +97,22 @@ OPTIONS
97
--expire <time>::
98
With `prune`, only expire unused worktrees older than <time>.
99
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
+
116
SEE ALSO
117
--------
118