comparison en/ch09-hook.xml @ 828:477d6a3e5023

Many final changes.

827:d2aacc06e562

    <title>An overview of hooks in Mercurial</title>

    <para id="x_1e8">Here is a brief list of the hooks that Mercurial
      supports. We will revisit each of these hooks in more detail
      later, in <xref linkend="sec:hook:ref"/>.</para>

    <itemizedlist>
      <listitem><para id="x_1e9"><literal role="hook">changegroup</literal>: This
	  is run after a group of changesets has been brought into the
	  repository from elsewhere.</para>

      <listitem><para id="x_1f5"><literal role="hook">update</literal>: This is
	  run after an update or merge of the working directory has
	  finished.
	</para>
      </listitem></itemizedlist>
    <para id="x_1f6">Each of the hooks whose description begins with the word
      <quote>Controlling</quote> has the ability to determine whether
      an activity can proceed.  If the hook succeeds, the activity may
      proceed; if it fails, the activity is either not permitted or
      undone, depending on the hook.
    </para>

  </sect1>
  <sect1>
    <title>Hooks and security</title>

	  hook will run under whatever account is executing the server
	  process, on the server.
	</para>
      </note>

      <para id="x_1fb">XXX To see what hooks are defined in a repository, use the
	<command role="hg-cmd">hg config hooks</command> command.  If
	you are working in one repository, but talking to another that
	you do not own (e.g. using <command role="hg-cmd">hg
	  pull</command> or <command role="hg-cmd">hg
	  incoming</command>), remember that it is the other
	repository's hooks you should be checking, not your own.
      </para>
    </sect2>

	the saved commit message once you've corrected the problem.
      </para>

      &interaction.ch09-hook.ws.better;

      <para id="x_237">As a final aside, note in the example above the use of
	<command>perl</command>'s in-place editing feature to get rid
	of trailing whitespace from a file.  This is concise and
	useful enough that I will reproduce it here.
      </para>
      <programlisting>perl -pi -e 's,\s+$,,' filename</programlisting>

    </sect2>
  </sect1>
  <sect1>

	<itemizedlist>
	  <listitem><para id="x_252"><envar
		role="rc-item-bugzilla">version</envar>: The version
	      of Bugzilla installed on the server.  The database
	      schema that Bugzilla uses changes occasionally, so this
	      hook has to know exactly which schema to use. At the
	      moment, the only version supported is
	      <literal>2.16</literal>.
	    </para>
	  </listitem>
	  <listitem><para id="x_253"><envar role="rc-item-bugzilla">host</envar>:
	      The hostname of the MySQL server that stores your
	      Bugzilla data.  The database must be configured to allow
	      connections from whatever host you are running the

828:477d6a3e5023

    <title>An overview of hooks in Mercurial</title>

    <para id="x_1e8">Here is a brief list of the hooks that Mercurial
      supports. We will revisit each of these hooks in more detail
      later, in <xref linkend="sec:hook:ref"/>.</para>

    <para id="x_1f6">Each of the hooks whose description begins with the word
      <quote>Controlling</quote> has the ability to determine whether
      an activity can proceed.  If the hook succeeds, the activity may
      proceed; if it fails, the activity is either not permitted or
      undone, depending on the hook.</para>

    <itemizedlist>
      <listitem><para id="x_1e9"><literal role="hook">changegroup</literal>: This
	  is run after a group of changesets has been brought into the
	  repository from elsewhere.</para>

      <listitem><para id="x_1f5"><literal role="hook">update</literal>: This is
	  run after an update or merge of the working directory has
	  finished.
	</para>
      </listitem></itemizedlist>

  </sect1>
  <sect1>
    <title>Hooks and security</title>

	  hook will run under whatever account is executing the server
	  process, on the server.
	</para>
      </note>

      <para id="x_1fb">To see what hooks are defined in a repository,
	use the <command role="hg-cmd">hg showconfig hooks</command>
	command.  If you are working in one repository, but talking to
	another that you do not own (e.g. using <command
	  role="hg-cmd">hg pull</command> or <command role="hg-cmd">hg
	  incoming</command>), remember that it is the other
	repository's hooks you should be checking, not your own.
      </para>
    </sect2>

	the saved commit message once you've corrected the problem.
      </para>

      &interaction.ch09-hook.ws.better;

      <para id="x_237">As a final aside, note in the example above the
	use of <command>sed</command>'s in-place editing feature to
	get rid of trailing whitespace from a file.  This is concise
	and useful enough that I will reproduce it here (using
	<command>perl</command> for good measure).</para>
      <programlisting>perl -pi -e 's,\s+$,,' filename</programlisting>

    </sect2>
  </sect1>
  <sect1>

	<itemizedlist>
	  <listitem><para id="x_252"><envar
		role="rc-item-bugzilla">version</envar>: The version
	      of Bugzilla installed on the server.  The database
	      schema that Bugzilla uses changes occasionally, so this
	      hook has to know exactly which schema to use.</para>
	  </listitem>
	  <listitem><para id="x_253"><envar role="rc-item-bugzilla">host</envar>:
	      The hostname of the MySQL server that stores your
	      Bugzilla data.  The database must be configured to allow
	      connections from whatever host you are running the