[PATCH v3 04/23] Documentation/git-worktree: add BUGS section
From: Eric Sunshine <hidden>
Date: 2016-06-15 23:05:40
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Relocate submodule warning to BUGS and enumerate missing commands. Signed-off-by: Eric Sunshine <redacted> --- Documentation/git-worktree.txt | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 3d28896..bf6a1e2 100644
--- 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. -Multiple checkout support for submodules is incomplete. It is NOT -recommended to make multiple checkouts of a superproject. - COMMANDS -------- prune::
@@ -100,6 +97,22 @@ OPTIONS --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 --------
--
2.5.0.rc1.197.g417e668