Browse Source

Documentation/git-worktree: add EXAMPLES section

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Eric Sunshine 10 years ago committed by Junio C Hamano
parent
commit
9645459756
  1. 22
      Documentation/git-worktree.txt

22
Documentation/git-worktree.txt

@ -105,6 +105,28 @@ to `/path/main/.git/worktrees/test-next` then a file named
`test-next` entry from being pruned. See `test-next` entry from being pruned. See
linkgit:gitrepository-layout[5] for details. linkgit:gitrepository-layout[5] for details.


EXAMPLES
--------
You are in the middle of a refactoring session and your boss comes in and
demands that you fix something immediately. You might typically use
linkgit:git-stash[1] to store your changes away temporarily, however, your
worktree is in such a state of disarray (with new, moved, and removed files,
and other bits and pieces strewn around) that you don't want to risk
disturbing any of it. Instead, you create a temporary linked worktree to
make the emergency fix, remove it when done, and then resume your earlier
refactoring session.

------------
$ git branch emergency-fix master
$ git checkout --to ../temp emergency-fix
$ pushd ../temp
# ... hack hack hack ...
$ git commit -a -m 'emergency fix for boss'
$ popd
$ rm -rf ../temp
$ git worktree prune
------------

BUGS BUGS
---- ----
Multiple checkout support for submodules is incomplete. It is NOT Multiple checkout support for submodules is incomplete. It is NOT

Loading…
Cancel
Save