From: Eric S. Raymond <esr@thyrsus.com>
Date: Sun, 30 Sep 2012 15:15:17 +0000 (-0400)
Subject: Documentation improvements.
X-Git-Tag: 1.3~29
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=493408a54f1e1f33346b7948d2c675030ca69603;p=irker.git

Documentation improvements.
---

diff --git a/irkerhook.xml b/irkerhook.xml
index 9efd9ee..3c28548 100644
--- a/irkerhook.xml
+++ b/irkerhook.xml
@@ -116,20 +116,19 @@ will take up less space in the notification line.</para>
 </varlistentry>
 </variablelist>
 
-
-
 <refsect2 id="git"><title>git</title>
 
 <para>Under git, <application>irkerhook.py</application> does not
 require any arguments.  All variables may be set in the repo
-<filename>config</filename> file, and are distinguished with
-the application prefix "irker.".  Command-line variable=value
-arguments are accepted but not required.  No attempt is made
-to interpret an <filename>irker.conf</filename> file.</para>
+<filename>config</filename> file, and are distinguished with the
+application prefix "irker.".  Command-line variable=value arguments
+are accepted but not required.  No attempt is made to interpret an
+<filename>irker.conf</filename> file.  You should not set the
+"repository" variable (an equivalent will be computed).</para>
 
 <para>The default value of the "project" variable is the basename
 of the repository directory. The default value of the "urlprefix"
-variable is "viewcvs".</para>
+variable is "cgit".</para>
 
 <para>There is one git-specific variable, "revformat", controlling
 the format of the commit identifier in a notification. It
@@ -172,7 +171,7 @@ given on the command line, and will override any settings in an
 
 <para>The default for the project variable is the basename of the
 (required) repository= argument.The default value of the "urlprefix"
-variable is "cgit".</para>
+variable is "viewcvs".</para>
 
 <para>If an <filename>irker.conf</filename> file exists in the repository
 root directory (not the checkout directory but where internals such as the
@@ -186,6 +185,9 @@ channels  = irc://chat.freenode/irker,irc://chat.freenode/commits
 tcp = false
 </programlisting>
 
+<para>Don't the "repository" or "commit" variables in this file;
+that would have unhappy results.</para>
+
 <para>There are no Subversion-specific variables.</para>
 
 </refsect2>