Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
V
vcsh
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Container registry
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Kevin Lyda
vcsh
Commits
23b0d9f4
Commit
23b0d9f4
authored
13 years ago
by
Richard Hartmann
Browse files
Options
Downloads
Patches
Plain Diff
Improve hook documentation
parent
ab60947b
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
Makefile
+1
-0
1 addition, 0 deletions
Makefile
doc/hooks
+7
-0
7 additions, 0 deletions
doc/hooks
doc/vcsh.1.ronn
+10
-6
10 additions, 6 deletions
doc/vcsh.1.ronn
with
18 additions
and
6 deletions
Makefile
+
1
−
0
View file @
23b0d9f4
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
doc/hooks
0 → 100644
+
7
−
0
View file @
23b0d9f4
Available hooks are:
pre-enter
post-enter
pre-run
post-run
pre-setup
post-setup
This diff is collapsed.
Click to expand it.
doc/vcsh.1.ronn
+
10
−
6
View file @
23b0d9f4
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment