source: trunk/hooks/post-lock.tmpl @ 523

Last change on this file since 523 was 523, checked in by test, 13 years ago
File size: 1.6 KB
Line 
1#!/bin/sh
2
3# POST-LOCK HOOK
4#
5# The post-lock hook is run after a path is locked.  Subversion runs
6# this hook by invoking a program (script, executable, binary, etc.)
7# named 'post-lock' (for which this file is a template) with the
8# following ordered arguments:
9#
10#   [1] REPOS-PATH   (the path to this repository)
11#   [2] USER         (the user who created the lock)
12#
13# The paths that were just locked are passed to the hook via STDIN (as
14# of Subversion 1.2, only one path is passed per invocation, but the
15# plan is to pass all locked paths at once, so the hook program
16# should be written accordingly).
17#
18# The default working directory for the invocation is undefined, so
19# the program should set one explicitly if it cares.
20#
21# Because the lock has already been created and cannot be undone,
22# the exit code of the hook program is ignored.  The hook program
23# can use the 'svnlook' utility to help it examine the
24# newly-created lock.
25#
26# On a Unix system, the normal procedure is to have 'post-lock'
27# invoke other programs to do the real work, though it may do the
28# work itself too.
29#
30# Note that 'post-lock' must be executable by the user(s) who will
31# invoke it (typically the user httpd runs as), and that user must
32# have filesystem-level permission to access the repository.
33#
34# On a Windows system, you should name the hook program
35# 'post-lock.bat' or 'post-lock.exe',
36# but the basic idea is the same.
37#
38# Here is an example hook script, for a Unix /bin/sh interpreter:
39
40REPOS="$1"
41USER="$2"
42
43# Send email to interested parties, let them know a lock was created:
44mailer.py lock "$REPOS" "$USER" /path/to/mailer.conf
Note: See TracBrowser for help on using the repository browser.