Skip to content
Snippets Groups Projects
Commit 23b0d9f4 authored by Richard Hartmann's avatar Richard Hartmann
Browse files

Improve hook documentation

parent ab60947b
Branches
Tags
No related merge requests found
......@@ -12,6 +12,7 @@ install: all
install -m 0644 $(manpages) $(DESTDIR)$(PREFIX)/share/man/man1
install -d $(DESTDIR)$(PREFIX)/share/doc/vcsh
install -m 0644 README.md $(DESTDIR)$(PREFIX)/share/doc/vcsh
install -m 0644 doc/hooks $(DESTDIR)$(PREFIX)/share/doc/vcsh
install -d $(DESTDIR)$(PREFIX)/share/zsh/vendor-completions
install -m 0644 _vcsh $(DESTDIR)$(PREFIX)/share/zsh/vendor-completions
......
Available hooks are:
pre-enter
post-enter
pre-run
post-run
pre-setup
post-setup
......@@ -118,17 +118,21 @@ placed in <$XDG_CONFIG_HOME/vcsh/hooks-available>. From there, they can be
soft-linked into <$XDG_CONFIG_HOME/vcsh/hooks-enabled>; `vcsh` will only
execute hooks that are in this directory.
Hooks follow a simple format. `pre-run` will be run before anything is run.
Hooks follow a simple format. <pre-run> will be run before anything is run.
If you want to have more than one script for a certain hook, just append
any kind of string to order them. A system of `pre-run`, `pre-run.10`,
`pre-run.20` etc is suggested; other options would be `pre-run-10` or
`pre-run.sh`. A dot after the hook name is optional.
any kind of string to order them. A system of <pre-run>, <pre-run.10>,
<pre-run.20> etc is suggested; other options would be <pre-run-10> or
<pre-run.sh>. A dot after the hook name is optional.
If you want to create hooks for a specific `vcsh` repository, simply prepend
the repository's name, followed by a dot, i.e. `zsh.pre-run`. Otherwise, the
If you want to create hooks for a specific <vcsh> repository, simply prepend
the repository's name, followed by a dot, i.e. <zsh.pre-run>. Otherwise, the
same rules as above apply. The dot between the repository's name and the hook
is mandatory, though.
Available hooks are <pre-enter>, <post-enter>, <pre-run>, <post-run>,
<pre-setup>, and <post-setup>. If you need more, vcsh is trivial to patch,
but please let upstream know so we can ship them by default.
## DETAILED HOWTO AND FURTHER READING
Man pages are intended to be short and thus often useless to glean best
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment