comparison en/ch09-hook.xml @ 821:88828b784971

Add more complex example hook

820:3edacbff2b43

	transaction will roll back; you'll have to re-enter the commit
	message after you fix the trailing whitespace and run <command
	  role="hg-cmd">hg commit</command> again.
      </para>

&interaction.hook.ws.simple;

      <para id="x_235">In this example, we introduce a simple <literal
	  role="hook">pretxncommit</literal> hook that checks for
	trailing whitespace.  This hook is short, but not very
	helpful.  It exits with an error status if a change adds a

	any information that might help us to identify the offending
	file or line.  It also has the nice property of not paying
	attention to unmodified lines; only lines that introduce new
	trailing whitespace cause problems.
      </para>

      <para id="x_236">The above version is much more complex, but also more
	useful.  It parses a unified diff to see if any lines add
	trailing whitespace, and prints the name of the file and the
	line number of each such occurrence.  Even better, if the

	use the <option role="hg-opt-commit">-l filename</option>
	option to <command role="hg-cmd">hg commit</command> to reuse
	the saved commit message once you've corrected the problem.
      </para>

&interaction.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.

821:88828b784971

	transaction will roll back; you'll have to re-enter the commit
	message after you fix the trailing whitespace and run <command
	  role="hg-cmd">hg commit</command> again.
      </para>

      &interaction.ch09-hook.ws.simple;

      <para id="x_235">In this example, we introduce a simple <literal
	  role="hook">pretxncommit</literal> hook that checks for
	trailing whitespace.  This hook is short, but not very
	helpful.  It exits with an error status if a change adds a

	any information that might help us to identify the offending
	file or line.  It also has the nice property of not paying
	attention to unmodified lines; only lines that introduce new
	trailing whitespace cause problems.
      </para>

      &ch09-check_whitespace.py.lst;

      <para id="x_236">The above version is much more complex, but also more
	useful.  It parses a unified diff to see if any lines add
	trailing whitespace, and prints the name of the file and the
	line number of each such occurrence.  Even better, if the

	use the <option role="hg-opt-commit">-l filename</option>
	option to <command role="hg-cmd">hg commit</command> to reuse
	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.