Version bump for release.

[irker.git] / irkerhook.xml

diff --git a/irkerhook.xml b/irkerhook.xml
index ae0aa556cb4d6e9190cc36bd72bf02b2576a40aa..a78801ab8f4e5a7d50824f6888fd1dbe37ba3fe5 100644 (file)
--- a/irkerhook.xml
+++ b/irkerhook.xml
@@ -100,7 +100,7 @@ Defaults to "false".</para>
 <listitem>
 <para>Changeset URL prefix for your repo. When the commit ID is appended
 to this, it should point at a CGI that will display the commit
-through cgit,gitweb or something similar. The defaults will probably
+through cgit, gitweb or something similar. The defaults will probably
 work if you have a typical gitweb/cgit setup.</para>
 
 <para>If the value of this variable is "None", generation of the URL
@@ -128,13 +128,13 @@ variable is "None", no compression will be attempted.</para>
 <para>If "mIRC", highlight notification fields with mIRC color codes.
 If "ANSI", highlight notification fields with ANSI color escape
 sequences.  Defaults to "none" (no colors). ANSI codes are supported
-in Chatzilla. irssi, ircle, and BitchX, but not in mIRC, XChat, KVirc or
-Konversation.</para>
+in Chatzilla, irssi, ircle, and BitchX; mIRC codes only are recognized
+in mIRC, XChat, KVirc, Konversation, or weechat.</para>
 
 <para>Note: if you turn this on and notifications stop appearing on
 your channel, you need to turn off IRC's color filter on that channel.
 To do this you will need op privileges; issue the command "/mode
-&lt;channel&gt; -c" with &lt;channel&gt; replaced by your chnnel name.
+&lt;channel&gt; -c" with &lt;channel&gt; replaced by your channel name.
 You may need to first issue the command "/msg chanserv set
 &lt;channel&gt; MLOCK +nt-slk".</para>
 </listitem>
@@ -193,6 +193,20 @@ irkerhook.py --refname=refs/heads/master HEAD
 <para>However, this will not give the right result when you push to 
 a non-default branch of a bare repo.</para>
 
+<para>A typical way to install this hook is actually in the
+<filename>post-receive</filename> hook, because it gets all the
+necessary details and will not abort the push on failure. Use the
+following script:</para>
+
+<programlisting>
+#!/bin/sh
+
+echo "sending IRC notification"
+while read old new refname; do
+    irkerhook --refname=${refname} $(git rev-list --reverse ${old}..${new})
+done
+</programlisting>
+
 <para>Preferences may be set in the repo <filename>config</filename>
 file in an [irker] section. Here is an example of what that can look
 like:</para>