druckdev/dotfiles
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

git:checkout-worktree: Update description

Browse Source 
Add description in one sentence and use cases for this.
Remove sentence about removing `TEMP_DIR` that is outdated since:
5a8b5ffd21 ("git:checkout-worktree: Use `mktemp` template")
This commit is contained in:
Julian Prein
2022-03-31 17:41:54 +02:00
parent 71450ad133
commit ab53cff2a3
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.config/zsh/autoload/git/git-checkout-worktree
View File

@@ -1,10 +1,16 @@
#!/usr/bin/env zsh #!/usr/bin/env zsh
# Create a temporary worktree.
#
# Useful for doing quick tasks on other branches without modifying the current
# working tree. So no broken/outdated symlinks to dotfiles or unnecessary
# recompiling after switching back for example.
#
# Checks out the first argument in a worktree at a temporary directory. Then # Checks out the first argument in a worktree at a temporary directory. Then
# spawns an interactive shell inside of it. # spawns an interactive shell inside of it.
# When the shell closes the worktree is tried to be removed. Until that works # When the shell closes the worktree is tried to be removed. Until that works
# without problems (e.g. dirty), a new shell is spawned to resolve all conflicts # without problems (e.g. dirty), a new shell is spawned to resolve all conflicts
# (e.g. stashing). Finally the temporary directory is deleted. # (e.g. stashing).
# #
# Instead of dropping in an interactive shell, the commands to execute can be # Instead of dropping in an interactive shell, the commands to execute can be
# passed via stdin. If any conflicts arise, all further shells are interactive. # passed via stdin. If any conflicts arise, all further shells are interactive.