aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-worktree.txt
diff options
context:
space:
mode:
authorEric Sunshine <sunshine@sunshineco.com>2015-07-06 13:30:41 -0400
committerJunio C Hamano <gitster@pobox.com>2015-07-06 11:07:43 -0700
commit6d3824cf92c14d81ffb2ecaa76e35a811b7f596f (patch)
tree9d8648668cfb5c9620c7b08e426ccfb4683f4cf7 /Documentation/git-worktree.txt
parent93a36493e2c9478c496328118dc52f6b270c7408 (diff)
downloadgit-6d3824cf92c14d81ffb2ecaa76e35a811b7f596f.tar.gz
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>
Diffstat (limited to 'Documentation/git-worktree.txt')
-rw-r--r--Documentation/git-worktree.txt19
1 files changed, 16 insertions, 3 deletions
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 3d288967f3..bf6a1e229c 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
--------