X-Git-Url: https://git.madduck.net/code/vcsh.git/blobdiff_plain/c872d3ba4d07ad3c09d2b96e0faec88ea3517d37..83ae3460b51c674802a6ab4859cbe8450e9e210c:/doc/hooks diff --git a/doc/hooks b/doc/hooks index c547e47..282ee86 100644 --- a/doc/hooks +++ b/doc/hooks @@ -1,14 +1,33 @@ Available hooks are: -* pre-command -* post-command -* pre-hook +* pre-clone * post-clone * post-clone-retired - use this if you need to operate on different git repositories after cloning + Use this if you need to operate on different git repositories after cloning. + This hook can be useful if your configuration needs some remote + repositories, but you do not want to include it into your vcsh + repository. For instance, if you use vim plugins manager (vundle, + NeoBundle), zsh configuration frameworks (oh-my-zsh, prezto), etc. +* pre-command +* post-command * pre-enter * post-enter +* pre-init +* post-init +* pre-merge + Use this hook to detect and handle merge conflicts before vcsh's native code + finds and errors on them. This is useful for allowing clones on top of existing + files. +* post-merge + Use this hook to finish handling any merge conflicts found in the pre-merge hook. +* pre-pull +* post-pull +* pre-push +* post-push * pre-run * post-run * pre-upgrade * post-upgrade + +If you write any interesting or useful hooks, please send them upstream +so they can be included in an examples section.