.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "SVN::Hooks::Generic 3pm"
.TH SVN::Hooks::Generic 3pm "2017-06-24" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SVN::Hooks::Generic \- Implement generic checks for all Subversion hooks.
.SH "VERSION"
.IX Header "VERSION"
version 1.34
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This SVN::Hooks plugin allows you to easily write generic checks for
all Subversion standard hooks. It's deprecated. You should use the
SVN::Hooks hook defining exported directives instead.
.PP
This module is configured by the following directive.
.SS "\s-1GENERIC\s0(\s-1HOOK\s0 => \s-1FUNCTION, HOOK\s0 => [\s-1FUNCTIONS\s0], ...)"
.IX Subsection "GENERIC(HOOK => FUNCTION, HOOK => [FUNCTIONS], ...)"
This directive associates \s-1FUNCTION\s0 with a specific \s-1HOOK.\s0 You can make
more than one association with a single directive call, or you can use
multiple calls to make multiple associations. Moreover, you can
associate a hook with a single function or with a list of functions
(passing them as elements of an array). All functions associated with
a hook will be called in an unspecified order with the same arguments.
.PP
Each hook must be associated with functions with a specific signature,
i.e., the arguments that are passed to the function depends on the
hook to which it is associated.
.PP
The hooks are specified by their standard names.
.PP
The function signatures are the following:
.IP "post\-commit(SVN::Look)" 4
.IX Item "post-commit(SVN::Look)"
.PD 0
.IP "post\-lock(repos\-path, username)" 4
.IX Item "post-lock(repos-path, username)"
.IP "post\-revprop\-change(SVN::Look, username, property-name, action)" 4
.IX Item "post-revprop-change(SVN::Look, username, property-name, action)"
.IP "post\-unlock(repos\-path, username)" 4
.IX Item "post-unlock(repos-path, username)"
.IP "pre\-commit(SVN::Look)" 4
.IX Item "pre-commit(SVN::Look)"
.IP "pre\-lock(repos\-path, path, username, comment, steal-lock-flag)" 4
.IX Item "pre-lock(repos-path, path, username, comment, steal-lock-flag)"
.IP "pre\-revprop\-change(SVN::Look, username, property-name, action)" 4
.IX Item "pre-revprop-change(SVN::Look, username, property-name, action)"
.IP "pre\-unlock(repos\-path, path, username, lock-token, break-unlock-flag)" 4
.IX Item "pre-unlock(repos-path, path, username, lock-token, break-unlock-flag)"
.IP "start\-commit(repos\-path, username, capabilities, txt-name)" 4
.IX Item "start-commit(repos-path, username, capabilities, txt-name)"
.PD
.PP
The functions may perform whatever checks they want. If the checks
succeed the function must simply return. Otherwise, they must die with
a suitable error message, which will be sent back to the user
performing the Subversion action which triggered the hook.
.PP
The sketch below shows how this directive could be used.
.PP
.Vb 4
\&        sub my_start_commit {
\&            my ($repo_path, $username, $capabilities, $txt_name) = @_;
\&            # ...
\&        }
\&
\&        sub my_pre_commit {
\&            my ($svnlook) = @_;
\&            # ...
\&        }
\&
\&        GENERIC(
\&            \*(Aqstart\-commit\*(Aq => \e&my_start_commit,
\&            \*(Aqpre\-commit\*(Aq   => \e&my_pre_commit,
\&        );
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Gustavo L. de M. Chaves <gnustavo@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by CPqD <www.cpqd.com.br>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.