From: Eric S. Raymond <esr@thyrsus.com>
Date: Thu, 4 Oct 2012 10:30:36 +0000 (-0400)
Subject: Document the test filter better.
X-Git-Tag: 1.7~18
X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=bbd8ed9fe5679d6eb85ddd183515e6bf5c95d5fc;p=irker.git

Document the test filter better.
---

diff --git a/filter-test.py b/filter-test.py
index ae91127..7373274 100755
--- a/filter-test.py
+++ b/filter-test.py
@@ -2,18 +2,17 @@
 #
 # Test hook to launch an irker instance (if it doesn't already exist)
 # just before shipping the notification. We start it in in another terminal
-# so you can watch the debug messages. Probably only of interest only to
+# so you can watch the debug messages. Intended to be used in the root
+# directory of the irker repo. Probably only of interest only to irker
 # developers
 #
-# To use it, set up irkerhook.py to file on each commit.
-# Then set the filtercmd variable in your repo config as follows:
+# To use this, set up irkerhook.py to fire on each commit.  Creating a
+# .git/hooks/post-commit file containing the line "irkerhook.py"; be
+# sure to make the opos-commit file executable.  Then set the
+# filtercmd variable in your repo config as follows:
 # 
 # [irker]
 # 	filtercmd = filter-test.py
-#
-# This is rather antisocial - imagine thousands of irkerds holding open
-# connections to IRCDs.  It's better to go through an instance running
-# at your forge or set up for shared use by your intranet administrator.
 
 import os, sys, json, subprocess, time
 metadata = json.loads(sys.argv[1])