X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=irkerhook.xml;h=a78801ab8f4e5a7d50824f6888fd1dbe37ba3fe5;hb=d06efb4065a6fa559e3f0927306cd7a8219e9a43;hp=d097aaaeb442d33a808073116b933483b64d56a2;hpb=83f573e597efdec1378b351ff7ccf762fb1d24ea;p=irker.git
diff --git a/irkerhook.xml b/irkerhook.xml
index d097aaa..a78801a 100644
--- a/irkerhook.xml
+++ b/irkerhook.xml
@@ -71,8 +71,7 @@ specified, defaults to a lowercased copy of the project name.
An IRC channel URL, or comma-separated list of same, identifying
channels to which notifications are to be sent. If not specified, the
-defaults channel list id the freenode #commits channel plus the freenode
-channel named by the project variable.
+default is the freenode #commits channel.
@@ -83,6 +82,13 @@ to reside. Defaults to "localhost".
+email
+
+If set, use email for communication rather than TCP or UDP.
+The value is used as the target mail address.
+
+
+
tcp
If "true", use TCP for communication; if "false", use UDP.
@@ -94,7 +100,7 @@ Defaults to "false".
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.
If the value of this variable is "None", generation of the URL
@@ -120,13 +126,17 @@ variable is "None", no compression will be attempted.
color
If "mIRC", highlight notification fields with mIRC color codes.
-If "ANSI", highlight notification fields with ANSI color escape sequences.
-Defaults to "none" (no colors). 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 #irker -c". You may need to
-first issue the command "/msg chanserv set #irker MLOCK
-+nt-slk".
+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; mIRC codes only are recognized
+in mIRC, XChat, KVirc, Konversation, or weechat.
+
+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
+<channel> -c" with <channel> replaced by your channel name.
+You may need to first issue the command "/msg chanserv set
+<channel> MLOCK +nt-slk".
@@ -143,6 +153,15 @@ to prevent shotgun spamming by malicious project owners. Setting it to
a value less than 2, however, would probably be unwise.
+
+cialike
+
+If not empty and not "None", this emulates the old CIA behavior
+of dropping long lists of files in favor of a summary of the form (N
+files in M directories). The value must be numeric giving a threshold
+value for the length of the file list in characters.
+
+
git
@@ -174,6 +193,20 @@ irkerhook.py --refname=refs/heads/master HEAD
However, this will not give the right result when you push to
a non-default branch of a bare repo.
+A typical way to install this hook is actually in the
+post-receive hook, because it gets all the
+necessary details and will not abort the push on failure. Use the
+following script:
+
+
+#!/bin/sh
+
+echo "sending IRC notification"
+while read old new refname; do
+ irkerhook --refname=${refname} $(git rev-list --reverse ${old}..${new})
+done
+
+
Preferences may be set in the repo config
file in an [irker] section. Here is an example of what that can look
like:
@@ -182,7 +215,7 @@ like:
[irker]
project = gpsd
color = ANSI
- channels = {irc://chat.freenode.net/gpsd, irc://chat.freenode.net/commits}
+ channels = irc://chat.freenode.net/gpsd,irc://chat.freenode.net/commits
You should not set the "repository" variable (an equivalent
@@ -224,10 +257,12 @@ the commit). The defaults are the current working directory and HEAD,
respectively.
Note, however, that you cannot default the
-repository argumment inside a Subversion post-commit hook. Instead,
-the values must be the two arguments that Subversion passes to that
-hook as arguments. Thus, a typical invocation in the post-commit
-script will look like this:
+repository argument inside a Subversion post-commit hook; this is
+because of a limitation of Subversion, which is that getting the
+current directory is not reliable inside these hooks. Instead, the
+values must be the two arguments that Subversion passes to that hook
+as arguments. Thus, a typical invocation in the post-commit script
+will look like this:
REPO=$1
@@ -353,6 +388,12 @@ terminate.
+SEE ALSO
+
+irkerd8,
+
+
+
AUTHOR
Eric S. Raymond esr@snark.thyrsus.com. See the
project page at