[svnbook] r4424 committed - * en/book/ref-reposhooks.xml...
svnbook at googlecode.com
svnbook at googlecode.com
Tue Feb 12 10:47:54 CST 2013
Revision: 4424
Author: cmpilato at gmail.com
Date: Tue Feb 12 08:47:37 2013
Log: * en/book/ref-reposhooks.xml
Fix indentation/whitespace/comments.
http://code.google.com/p/svnbook/source/detail?r=4424
Modified:
/trunk/en/book/ref-reposhooks.xml
=======================================
--- /trunk/en/book/ref-reposhooks.xml Tue Feb 12 08:38:43 2013
+++ /trunk/en/book/ref-reposhooks.xml Tue Feb 12 08:47:37 2013
@@ -32,695 +32,691 @@
</partintro>
- <!-- =================================================================
-->
- <!-- =================================================================
-->
- <!-- =================================================================
-->
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.start-commit">
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.start-commit">
-
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>start-commit</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>start-commit</secondary>
+ </indexterm>
- <refnamediv>
- <refname>start-commit</refname>
- <refpurpose>Notification of the beginning of a commit.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>start-commit</refname>
+ <refpurpose>Notification of the beginning of a commit.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>start-commit
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>USER</replaceable>
- <replaceable>CAPABILITIES</replaceable>
- <replaceable>TXN-NAME</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>start-commit
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>USER</replaceable>
+ <replaceable>CAPABILITIES</replaceable>
+ <replaceable>TXN-NAME</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
-
- <para>The start-commit hook is run immediately after the
- commit transaction is created and its initial properties
- set. It is typically used as an early termination
- mechanism, avoiding what could be a lengthy commit process
- which would eventually fail at a later phase anyway due to a
- user's lack of commit privileges or some other commit
- metadata validation failure.</para>
+ <refsect1>
+ <title>Description</title>
+
+ <para>The start-commit hook is run immediately after the
+ commit transaction is created and its initial properties
+ set. It is typically used as an early termination
+ mechanism, avoiding what could be a lengthy commit process
+ which would eventually fail at a later phase anyway due to a
+ user's lack of commit privileges or some other commit
+ metadata validation failure.</para>
- <para>If the start-commit hook program returns a nonzero exit
- value, the commit process is stopped, the commit transaction
- is destroyed, and anything printed to
- <filename>stderr</filename> is marshalled back to the
- client.</para>
+ <para>If the start-commit hook program returns a nonzero exit
+ value, the commit process is stopped, the commit transaction
+ is destroyed, and anything printed to
+ <filename>stderr</filename> is marshalled back to the
+ client.</para>
- <para>The start-commit hook is not a suitable place to
- evaluate the substance of a particular commit, as it is
- invoked before any file or directory change information has
- been transmitted. Use the pre-commit hook script (which is
- described in <xref linkend="svn.ref.reposhooks.pre-commit"
- /> elsewhere in this reference) for that purpose.</para>
+ <para>The start-commit hook is not a suitable place to
+ evaluate the substance of a particular commit, as it is
+ invoked before any file or directory change information has
+ been transmitted. Use the pre-commit hook script (which is
+ described in <xref linkend="svn.ref.reposhooks.pre-commit"
+ /> elsewhere in this reference) for that purpose.</para>
- <note>
- <para>Prior to Subversion 1.8, the Subversion invoked the
- start-commit hook <emphasis>before</emphasis> creating the
- commit transaction. Failure of the script resulted in that
- transaction not being created at all. This was changed in
- Subversion 1.8, though, to allow implementations of the
- start-commit hook access to the transaction's properties,
- which can include (among other things) the revision log
- associated with the commit.</para>
- </note>
+ <note>
+ <para>Prior to Subversion 1.8, the Subversion invoked the
+ start-commit hook <emphasis>before</emphasis> creating the
+ commit transaction. Failure of the script resulted in that
+ transaction not being created at all. This was changed in
+ Subversion 1.8, though, to allow implementations of the
+ start-commit hook access to the transaction's properties,
+ which can include (among other things) the revision log
+ associated with the commit.</para>
+ </note>
- </refsect1>
+ </refsect1>
- <refsect1>
- <title>Input Parameter(s)</title>
+ <refsect1>
+ <title>Input Parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
-
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Authenticated username attempting the commit</para>
- </listitem>
- <listitem>
- <para>Colon-separated list of
- capabilities that a client passes to the server,
- including <literal>depth</literal>,
- <literal>mergeinfo</literal>, and
- <literal>log-revprops</literal> (new in Subversion
1.5)</para>
- </listitem>
- <listitem>
- <para>Commit transaction name (new in Subversion 1.8)</para>
- </listitem>
- </orderedlist>
- </refsect1>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
- <refsect1>
- <title>Common uses</title>
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Authenticated username attempting the commit</para>
+ </listitem>
+ <listitem>
+ <para>Colon-separated list of
+ capabilities that a client passes to the server,
+ including <literal>depth</literal>,
+ <literal>mergeinfo</literal>, and
+ <literal>log-revprops</literal> (new in Subversion 1.5)</para>
+ </listitem>
+ <listitem>
+ <para>Commit transaction name (new in Subversion 1.8)</para>
+ </listitem>
+ </orderedlist>
+ </refsect1>
+
+ <refsect1>
+ <title>Common uses</title>
- <para>Access control (e.g., temporarily lock out commits for
- some reason).</para>
+ <para>Access control (e.g., temporarily lock out commits for
+ some reason).</para>
- <para>A means to allow access only from clients that have
- certain capabilities.</para>
- </refsect1>
+ <para>A means to allow access only from clients that have
+ certain capabilities.</para>
+ </refsect1>
- </refentry>
-
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.pre-commit">
+ </refentry>
+
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.pre-commit">
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>pre-commit</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>pre-commit</secondary>
+ </indexterm>
- <refnamediv>
- <refname>pre-commit</refname>
- <refpurpose>Notification just prior to commit
completion.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>pre-commit</refname>
+ <refpurpose>Notification just prior to commit
completion.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>pre-commit
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>TXN-NAME</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>pre-commit
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>TXN-NAME</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
+ <refsect1>
+ <title>Description</title>
- <para>The <literal>pre-commit</literal> hook is run just
- before a commit transaction is promoted to a new revision.
- Typically, this hook is used to protect against commits that
- are disallowed due to content or location (e.g., your
- site might require that all commits to a certain branch
- include a ticket number from the bug tracker, or that the
- incoming log message is nonempty).</para>
+ <para>The <literal>pre-commit</literal> hook is run just
+ before a commit transaction is promoted to a new revision.
+ Typically, this hook is used to protect against commits that
+ are disallowed due to content or location (e.g., your
+ site might require that all commits to a certain branch
+ include a ticket number from the bug tracker, or that the
+ incoming log message is nonempty).</para>
- <para>If the <literal>pre-commit</literal> hook program
- returns a nonzero exit value, the commit is aborted, the
- commit transaction is removed, and anything printed to
- <filename>stderr</filename> is marshalled back to the
client.</para>
+ <para>If the <literal>pre-commit</literal> hook program
+ returns a nonzero exit value, the commit is aborted, the
+ commit transaction is removed, and anything printed to
+ <filename>stderr</filename> is marshalled back to the
client.</para>
- </refsect1>
+ </refsect1>
- <refsect1>
- <title>Input parameter(s)</title>
+ <refsect1>
+ <title>Input parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Commit transaction name</para>
- </listitem>
- </orderedlist>
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Commit transaction name</para>
+ </listitem>
+ </orderedlist>
- <para>Additionally, Subversion passes any lock tokens provided
- by the committing client to the hook script via standard
- input. When present, these are formatted as a single line
- containing the string <literal>LOCK-TOKENS:</literal>,
- followed by additional lines—one per lock
- token—which contain the lock token information. Each
- lock token information line consists of the URI-escaped
- repository filesystem path associated with the lock,
- followed by the pipe (<literal>|</literal>) separator
- character, and finally the lock token string.</para>
+ <para>Additionally, Subversion passes any lock tokens provided
+ by the committing client to the hook script via standard
+ input. When present, these are formatted as a single line
+ containing the string <literal>LOCK-TOKENS:</literal>,
+ followed by additional lines—one per lock
+ token—which contain the lock token information. Each
+ lock token information line consists of the URI-escaped
+ repository filesystem path associated with the lock,
+ followed by the pipe (<literal>|</literal>) separator
+ character, and finally the lock token string.</para>
- </refsect1>
+ </refsect1>
+
+ <refsect1>
+ <title>Common uses</title>
+ <para>Change validation and control</para>
+ </refsect1>
+
+ </refentry>
- <refsect1>
- <title>Common uses</title>
- <para>Change validation and control</para>
- </refsect1>
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.post-commit">
- </refentry>
-
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.post-commit">
-
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>post-commit</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>post-commit</secondary>
+ </indexterm>
- <refnamediv>
- <refname>post-commit</refname>
- <refpurpose>Notification of a successful commit.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>post-commit</refname>
+ <refpurpose>Notification of a successful commit.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>post-commit
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>REVISION</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>post-commit
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>REVISION</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
+ <refsect1>
+ <title>Description</title>
- <para>The <literal>post-commit</literal> hook is run after the
- transaction is committed and a new revision is created. Most
- people use this hook to send out descriptive emails about
- the commit or to notify some other tool (such as an issue
- tracker) that a commit has happened. Some configurations
- also use this hook to trigger backup processes.</para>
+ <para>The <literal>post-commit</literal> hook is run after the
+ transaction is committed and a new revision is created. Most
+ people use this hook to send out descriptive emails about
+ the commit or to notify some other tool (such as an issue
+ tracker) that a commit has happened. Some configurations
+ also use this hook to trigger backup processes.</para>
- <para>If the <literal>post-commit</literal> hook returns a
- nonzero exit status, the commit <emphasis>will
- not</emphasis> be aborted since it has already
- completed. However, anything that the hook printed
- to <filename>stderr</filename> will be marshalled back to the
- client, making it easier to diagnose hook failures.</para>
-
- </refsect1>
+ <para>If the <literal>post-commit</literal> hook returns a
+ nonzero exit status, the commit <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <filename>stderr</filename> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
+
+ </refsect1>
- <refsect1>
- <title>Input parameter(s)</title>
+ <refsect1>
+ <title>Input parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
-
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Revision number created by the commit</para>
- </listitem>
- </orderedlist>
- </refsect1>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
- <refsect1>
- <title>Common uses</title>
- <para>Commit notification; tool integration</para>
- </refsect1>
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Revision number created by the commit</para>
+ </listitem>
+ </orderedlist>
+ </refsect1>
+
+ <refsect1>
+ <title>Common uses</title>
+ <para>Commit notification; tool integration</para>
+ </refsect1>
- </refentry>
-
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.pre-revprop-change">
+ </refentry>
+
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.pre-revprop-change">
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>pre-revprop-change</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>pre-revprop-change</secondary>
+ </indexterm>
- <refnamediv>
- <refname>pre-revprop-change</refname>
- <refpurpose>Notification of a revision property change
- attempt.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>pre-revprop-change</refname>
+ <refpurpose>Notification of a revision property change
+ attempt.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>pre-revprop-change
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>REVISION</replaceable>
- <replaceable>USER</replaceable>
- <replaceable>PROPNAME</replaceable>
- <replaceable>ACTION</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>pre-revprop-change
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>REVISION</replaceable>
+ <replaceable>USER</replaceable>
+ <replaceable>PROPNAME</replaceable>
+ <replaceable>ACTION</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
+ <refsect1>
+ <title>Description</title>
- <para>The <literal>pre-revprop-change</literal> hook is run
- immediately prior to the modification of a revision property
- when performed outside the scope of a normal commit. Unlike
- the other hooks, the default state of this one is to deny
- the proposed action. The hook must actually exist and
- return a zero exit value before a revision property
- modification can happen.</para>
+ <para>The <literal>pre-revprop-change</literal> hook is run
+ immediately prior to the modification of a revision property
+ when performed outside the scope of a normal commit. Unlike
+ the other hooks, the default state of this one is to deny
+ the proposed action. The hook must actually exist and
+ return a zero exit value before a revision property
+ modification can happen.</para>
- <para>If the <literal>pre-revprop-change</literal> hook
- doesn't exist, isn't executable, or returns a nonzero exit
- value, no change to the property will be made, and anything
- printed to <filename>stderr</filename> is marshalled back to the
client.</para>
+ <para>If the <literal>pre-revprop-change</literal> hook doesn't
+ exist, isn't executable, or returns a nonzero exit value, no
+ change to the property will be made, and anything printed
+ to <filename>stderr</filename> is marshalled back to the
+ client.</para>
- </refsect1>
+ </refsect1>
- <refsect1>
- <title>Input parameter(s)</title>
+ <refsect1>
+ <title>Input parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Revision whose property is about to be modified</para>
- </listitem>
- <listitem>
- <para>Authenticated username attempting the property
change</para>
- </listitem>
- <listitem>
- <para>Name of the property changed</para>
- </listitem>
- <listitem>
- <para>Change description: <literal>A</literal> (added),
- <literal>D</literal> (deleted), or <literal>M</literal>
- (modified)</para>
- </listitem>
- </orderedlist>
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Revision whose property is about to be modified</para>
+ </listitem>
+ <listitem>
+ <para>Authenticated username attempting the property
change</para>
+ </listitem>
+ <listitem>
+ <para>Name of the property changed</para>
+ </listitem>
+ <listitem>
+ <para>Change description: <literal>A</literal> (added),
+ <literal>D</literal> (deleted), or <literal>M</literal>
+ (modified)</para>
+ </listitem>
+ </orderedlist>
- <para>Additionally, Subversion passes the intended new value
- of the property to the hook program via standard
- input.</para>
+ <para>Additionally, Subversion passes the intended new value
+ of the property to the hook program via standard
+ input.</para>
- </refsect1>
+ </refsect1>
+
+ <refsect1>
+ <title>Common uses</title>
+ <para>Access control; change validation and control</para>
+ </refsect1>
+
+ </refentry>
- <refsect1>
- <title>Common uses</title>
- <para>Access control; change validation and control</para>
- </refsect1>
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.post-revprop-change">
- </refentry>
-
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.post-revprop-change">
-
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>post-revprop-change</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>post-revprop-change</secondary>
+ </indexterm>
- <refnamediv>
- <refname>post-revprop-change</refname>
- <refpurpose>Notification of a successful revision property
- change.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>post-revprop-change</refname>
+ <refpurpose>Notification of a successful revision property
+ change.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>post-revprop-change
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>REVISION</replaceable>
- <replaceable>USER</replaceable>
- <replaceable>PROPNAME</replaceable>
- <replaceable>ACTION</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>post-revprop-change
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>REVISION</replaceable>
+ <replaceable>USER</replaceable>
+ <replaceable>PROPNAME</replaceable>
+ <replaceable>ACTION</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
+ <refsect1>
+ <title>Description</title>
- <para>The <literal>post-revprop-change</literal> hook is run
- immediately after the modification of a revision property
- when performed outside the scope of a normal commit. As you can
- derive from the description of its counterpart, the
- <literal>pre-revprop-change</literal> hook, this hook will
- not run at all unless
- the <literal>pre-revprop-change</literal> hook is
- implemented. It is typically used to send email
- notification of the property change.</para>
+ <para>The <literal>post-revprop-change</literal> hook is run
+ immediately after the modification of a revision property
+ when performed outside the scope of a normal commit. As you can
+ derive from the description of its counterpart, the
+ <literal>pre-revprop-change</literal> hook, this hook will
+ not run at all unless
+ the <literal>pre-revprop-change</literal> hook is
+ implemented. It is typically used to send email
+ notification of the property change.</para>
- <para>If the <literal>post-revprop-change</literal> hook returns a
- nonzero exit status, the change <emphasis>will
- not</emphasis> be aborted since it has already
- completed. However, anything that the hook printed
- to <filename>stderr</filename> will be marshalled back to the
- client, making it easier to diagnose hook failures.</para>
+ <para>If the <literal>post-revprop-change</literal> hook returns a
+ nonzero exit status, the change <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <filename>stderr</filename> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
- </refsect1>
+ </refsect1>
- <refsect1>
- <title>Input parameter(s)</title>
+ <refsect1>
+ <title>Input parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
-
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Revision whose property was modified</para>
- </listitem>
- <listitem>
- <para>Authenticated username of the person making the
change</para>
- </listitem>
- <listitem>
- <para>Name of the property changed</para>
- </listitem>
- <listitem>
- <para>Change description: <literal>A</literal> (added),
- <literal>D</literal> (deleted), or <literal>M</literal>
- (modified)</para>
- </listitem>
- </orderedlist>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Revision whose property was modified</para>
+ </listitem>
+ <listitem>
+ <para>Authenticated username of the person making the
change</para>
+ </listitem>
+ <listitem>
+ <para>Name of the property changed</para>
+ </listitem>
+ <listitem>
+ <para>Change description: <literal>A</literal> (added),
+ <literal>D</literal> (deleted), or <literal>M</literal>
+ (modified)</para>
+ </listitem>
+ </orderedlist>
- <para>Additionally, Subversion passes to the hook program, via
- standard input, the previous value of the property.</para>
+ <para>Additionally, Subversion passes to the hook program, via
+ standard input, the previous value of the property.</para>
- </refsect1>
+ </refsect1>
+
+ <refsect1>
+ <title>Common uses</title>
+ <para>Property change notification</para>
+ </refsect1>
+
+ </refentry>
- <refsect1>
- <title>Common uses</title>
- <para>Property change notification</para>
- </refsect1>
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.pre-lock">
- </refentry>
-
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.pre-lock">
-
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>pre-lock</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>pre-lock</secondary>
+ </indexterm>
- <refnamediv>
- <refname>pre-lock</refname>
- <refpurpose>Notification of a path lock attempt.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>pre-lock</refname>
+ <refpurpose>Notification of a path lock attempt.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>pre-lock
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>PATH</replaceable>
- <replaceable>USER</replaceable>
- <replaceable>COMMENT</replaceable>
- <replaceable>STEAL</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>pre-lock
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>PATH</replaceable>
+ <replaceable>USER</replaceable>
+ <replaceable>COMMENT</replaceable>
+ <replaceable>STEAL</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
+ <refsect1>
+ <title>Description</title>
- <para>The <literal>pre-lock</literal> hook runs whenever
- someone attempts to lock a path. It can be used to prevent
- locks altogether or to create a more complex policy
- specifying exactly which users are allowed to lock
- particular paths. If the hook notices a preexisting lock,
- it can also decide whether a user is allowed
- to <quote>steal</quote> the existing lock.</para>
+ <para>The <literal>pre-lock</literal> hook runs whenever
+ someone attempts to lock a path. It can be used to prevent
+ locks altogether or to create a more complex policy
+ specifying exactly which users are allowed to lock
+ particular paths. If the hook notices a preexisting lock,
+ it can also decide whether a user is allowed
+ to <quote>steal</quote> the existing lock.</para>
- <para>If the <literal>pre-lock</literal> hook program returns
- a nonzero exit value, the lock action is aborted and
- anything printed to <filename>stderr</filename> is
- marshalled back to the client.</para>
+ <para>If the <literal>pre-lock</literal> hook program returns
+ a nonzero exit value, the lock action is aborted and
+ anything printed to <filename>stderr</filename> is
+ marshalled back to the client.</para>
- <para>The hook program may optionally dictate the lock token
- which will be assigned to the lock by printing the desired
- lock token to standard output. Because of this,
- implementations of this hook should carefully avoid
- unexpected output sent to standard output.</para>
+ <para>The hook program may optionally dictate the lock token
+ which will be assigned to the lock by printing the desired
+ lock token to standard output. Because of this,
+ implementations of this hook should carefully avoid
+ unexpected output sent to standard output.</para>
- <warning>
- <para>If the <literal>pre-lock</literal> script takes
- advantage of lock token dictation feature, the
- responsibility of generating a <emphasis>unique</emphasis>
- lock token falls to the script itself. Failure to
- generate unique lock tokens may result in
- undefined—and very likely,
- undesired—behavior.</para>
- </warning>
+ <warning>
+ <para>If the <literal>pre-lock</literal> script takes
+ advantage of lock token dictation feature, the
+ responsibility of generating a <emphasis>unique</emphasis>
+ lock token falls to the script itself. Failure to
+ generate unique lock tokens may result in
+ undefined—and very likely,
+ undesired—behavior.</para>
+ </warning>
- </refsect1>
+ </refsect1>
- <refsect1>
- <title>Input parameter(s)</title>
+ <refsect1>
+ <title>Input parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
-
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Versioned path that is to be locked</para>
- </listitem>
- <listitem>
- <para>Authenticated username of the person attempting the
- lock</para>
- </listitem>
- <listitem>
- <para>Comment provided when the lock was created</para>
- </listitem>
- <listitem>
- <para><literal>1</literal> if the user is attempting to
- steal an existing lock; <literal>0</literal>
- otherwise</para>
- </listitem>
- </orderedlist>
- </refsect1>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
- <refsect1>
- <title>Common uses</title>
- <para>Access control</para>
- </refsect1>
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Versioned path that is to be locked</para>
+ </listitem>
+ <listitem>
+ <para>Authenticated username of the person attempting the
+ lock</para>
+ </listitem>
+ <listitem>
+ <para>Comment provided when the lock was created</para>
+ </listitem>
+ <listitem>
+ <para><literal>1</literal> if the user is attempting to
+ steal an existing lock; <literal>0</literal>
+ otherwise</para>
+ </listitem>
+ </orderedlist>
+ </refsect1>
+
+ <refsect1>
+ <title>Common uses</title>
+ <para>Access control</para>
+ </refsect1>
- </refentry>
-
- <!-- ===============================================================
-->
- <refentry id="svn.ref.reposhooks.post-lock">
+ </refentry>
+
+ <!-- =============================================================== -->
+ <refentry id="svn.ref.reposhooks.post-lock">
- <indexterm>
- <primary>hook scripts</primary>
- <secondary>post-lock</secondary>
- </indexterm>
+ <indexterm>
+ <primary>hook scripts</primary>
+ <secondary>post-lock</secondary>
+ </indexterm>
- <refnamediv>
- <refname>post-lock</refname>
- <refpurpose>Notification of a successful path lock.</refpurpose>
- </refnamediv>
+ <refnamediv>
+ <refname>post-lock</refname>
+ <refpurpose>Notification of a successful path lock.</refpurpose>
+ </refnamediv>
- <refsynopsisdiv>
- <para><literal>post-lock
- <replaceable>REPOS-PATH</replaceable>
- <replaceable>USER</replaceable></literal></para>
- </refsynopsisdiv>
+ <refsynopsisdiv>
+ <para><literal>post-lock
+ <replaceable>REPOS-PATH</replaceable>
+ <replaceable>USER</replaceable></literal></para>
+ </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
+ <refsect1>
+ <title>Description</title>
- <para>The <literal>post-lock</literal> hook runs after one or
- more paths have been locked. It is typically used to send
- email notification of the lock event.</para>
+ <para>The <literal>post-lock</literal> hook runs after one or
+ more paths have been locked. It is typically used to send
+ email notification of the lock event.</para>
- <para>If the <literal>post-lock</literal> hook returns a
- nonzero exit status, the lock <emphasis>will
- not</emphasis> be aborted since it has already
- completed. However, anything that the hook printed
- to <filename>stderr</filename> will be marshalled back to the
- client, making it easier to diagnose hook failures.</para>
+ <para>If the <literal>post-lock</literal> hook returns a
+ nonzero exit status, the lock <emphasis>will
+ not</emphasis> be aborted since it has already
+ completed. However, anything that the hook printed
+ to <filename>stderr</filename> will be marshalled back to the
+ client, making it easier to diagnose hook failures.</para>
- </refsect1>
+ </refsect1>
- <refsect1>
- <title>Input parameter(s)</title>
+ <refsect1>
+ <title>Input parameter(s)</title>
- <para>The command-line arguments passed to the hook program,
- in order, are:</para>
-
- <orderedlist>
- <listitem>
- <para>Repository path</para>
- </listitem>
- <listitem>
- <para>Authenticated username of the person who locked the
- paths</para>
- </listitem>
- </orderedlist>
+ <para>The command-line arguments passed to the hook program,
+ in order, are:</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Repository path</para>
+ </listitem>
+ <listitem>
+ <para>Authenticated username of the person who locked the
+ paths</para>
+ </listitem>
+ </orderedlist>
- <para>Additionally, the list of paths locked is passed to the
- hook program via standard input, one path per line.</para>
+ <para>Additionally, the list of paths locked is passed to the
+ hook program via standard input, one path per line.</para>
- </refsect1>
+ </refsect1>
***The diff for this file has been truncated for email.***
More information about the svnbook-dev
mailing list