kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

git-worktree.txt: recommend 'git worktree remove' over manual deletion 

When cc73385cf6 (worktree remove: new command, 2018-02-12) implemented
and documented 'git worktree remove', it forgot to update existing
instructions suggesting manual deletion. Fix this oversight by
recommending 'git worktree remove' instead.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Eric Sunshine 2018-04-09 03:33:59 -04:00 committed by Junio C Hamano
parent b1801b85a3
commit 3f0b42bd07
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/git-worktree.txt
View File

@ -27,11 +27,12 @@ out more than one branch at a time. With `git worktree add` a new working
tree is associated with the repository. This new working tree is called a tree is associated with the repository. This new working tree is called a
"linked working tree" as opposed to the "main working tree" prepared by "git "linked working tree" as opposed to the "main working tree" prepared by "git
init" or "git clone". A repository has one main working tree (if it's not a init" or "git clone". A repository has one main working tree (if it's not a
bare repository) and zero or more linked working trees. bare repository) and zero or more linked working trees. When you are done
with a linked working tree, remove it with `git worktree remove`.


When you are done with a linked working tree you can simply delete it. If a working tree is deleted without using `git worktree remove`, then
The working tree's administrative files in the repository (see its associated administrative files, which reside in the repository
"DETAILS" below) will eventually be removed automatically (see (see "DETAILS" below), will eventually be removed automatically (see
`gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run `gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run
`git worktree prune` in the main or any linked working tree to `git worktree prune` in the main or any linked working tree to
clean up any stale administrative files. clean up any stale administrative files.
@ -105,7 +106,7 @@ OPTIONS
By default, `add` refuses to create a new working tree when By default, `add` refuses to create a new working tree when
`<commit-ish>` is a branch name and is already checked out by `<commit-ish>` is a branch name and is already checked out by
another working tree and `remove` refuses to remove an unclean another working tree and `remove` refuses to remove an unclean
working tree. This option overrides that safeguard. working tree. This option overrides these safeguards.


-b <new-branch>:: -b <new-branch>::
-B <new-branch>:: -B <new-branch>::
@ -277,8 +278,7 @@ $ pushd ../temp
# ... hack hack hack ... # ... hack hack hack ...
$ git commit -a -m 'emergency fix for boss' $ git commit -a -m 'emergency fix for boss'
$ popd $ popd
$ rm -rf ../temp $ git worktree remove ../temp
$ git worktree prune
------------ ------------


BUGS BUGS