vcsh: Implement pre-/post-init hooks

[code/vcsh.git] / doc / hooks

diff --git a/doc/hooks b/doc/hooks
index 036e2dc6a28ca6e76e4a4a504b8a224abee7a21f..54ff795611c0081e11eca8d16064f0f57f2ac60e 100644 (file)
--- a/doc/hooks
+++ b/doc/hooks
@@ -1,9 +1,27 @@
 Available hooks are:
-pre-command
-post-command
-pre-enter
-post-enter
-pre-run
-post-run
-pre-setup
-post-setup
+
+* pre-clone
+* post-clone
+* post-clone-retired
+       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-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.