Skip to content

Commit

Permalink
Documentation/git-worktree: add BUGS section
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Eric Sunshine authored and Junio C Hamano committed Jul 6, 2015
1 parent 93a3649 commit 6d3824c
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions Documentation/git-worktree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand All @@ -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
--------

Expand Down

0 comments on commit 6d3824c

Please sign in to comment.