From: Richard Kettlewell <rjk@greenend.org.uk>
Date: Sun, 18 May 2008 18:39:41 +0000 (+0100)
Subject: Documentation tweaks
X-Git-Tag: 4.0~76^2~5
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/commitdiff_plain/c6e44487b124077c23c7e95059b908c77ffdc4a3

Documentation tweaks
---

diff --git a/.bzrignore b/.bzrignore
index c701a86..b3032ad 100644
--- a/.bzrignore
+++ b/.bzrignore
@@ -185,3 +185,5 @@ doc/disorder_actions.5
 doc/disorder_actions.5.html
 doc/disorder_options.5
 doc/disorder_options.5.html
+doc/disorder_actions.5.in
+doc/disorder_templates.5.in
diff --git a/doc/Makefile.am b/doc/Makefile.am
index cff3570..4b01791 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -32,7 +32,8 @@ SEDFILES=disorder.1 disorderd.8 disorder_config.5 \
 	disorder-dump.8 disorder_protocol.5 disorder-deadlock.8 \
 	disorder-rescan.8 disobedience.1 disorderfm.1 disorder-playrtp.1 \
 	disorder-decode.8 disorder-stats.8 disorder-dbupgrade.8 \
-	disorder_options.5 disorder.cgi.8
+	disorder_options.5 disorder.cgi.8 disorder_templates.5 \
+	disorder_actions.5
 
 include ${top_srcdir}/scripts/sedfiles.make
 
@@ -50,7 +51,7 @@ $(TMPLMAN) : %.tmpl : % $(top_srcdir)/scripts/htmlman
 	chmod 444 $@.new
 	mv -f $@.new $@
 
-disorder_templates.5: disorder_templates.5.head disorder_templates.5.tail \
+disorder_templates.5.in: disorder_templates.5.head disorder_templates.5.tail \
 		$(top_srcdir)/lib/macros-builtin.c \
 		$(top_srcdir)/server/macros-disorder.c \
 		$(top_srcdir)/scripts/macro-docs
@@ -60,9 +61,9 @@ disorder_templates.5: disorder_templates.5.head disorder_templates.5.tail \
 		$(top_srcdir)/lib/macros-builtin.c \
 		$(top_srcdir)/server/macros-disorder.c 
 	cat ${srcdir}/disorder_templates.5.tail >> disorder_templates.5.new
-	mv disorder_templates.5.new disorder_templates.5
+	mv disorder_templates.5.new disorder_templates.5.in
 
-disorder_actions.5: disorder_actions.5.head disorder_actions.5.tail \
+disorder_actions.5.in: disorder_actions.5.head disorder_actions.5.tail \
 		$(top_srcdir)/lib/macros-builtin.c \
 		$(top_srcdir)/server/actions.c \
 		$(top_srcdir)/scripts/macro-docs
@@ -71,7 +72,7 @@ disorder_actions.5: disorder_actions.5.head disorder_actions.5.tail \
 	$(top_srcdir)/scripts/macro-docs >> disorder_actions.5.new \
 		$(top_srcdir)/server/actions.c 
 	cat ${srcdir}/disorder_actions.5.tail >> disorder_actions.5.new
-	mv disorder_actions.5.new disorder_actions.5
+	mv disorder_actions.5.new disorder_actions.5.in
 
 EXTRA_DIST=disorderd.8.in disorder.1.in disorder_config.5.in \
 	   disorder.3 disorder-dump.8.in disorder_protocol.5.in \
diff --git a/doc/disorder_actions.5.head b/doc/disorder_actions.5.head
index 34367e7..c093a2d 100644
--- a/doc/disorder_actions.5.head
+++ b/doc/disorder_actions.5.head
@@ -30,8 +30,8 @@ If no action is set, then the default is \fBplaying\fR, unless the argument
 \fBc\fR is present, in which case it is \fBconfirm\fR.
 This is a hack to keep confirmation URLs short.
 .SS Redirection
-For actions in the list, if it is not specified what template they expand, they
-redirect according to the value of the \fBback\fR argument.
+Actions in the list below that do not documented what template they expand
+issue an HTTP redirect according to the value of the \fBback\fR argument.
 There are three possibilities:
 .TP
 .BR 1 )
diff --git a/doc/disorder_templates.5.head b/doc/disorder_templates.5.head
index f876f80..4170c32 100644
--- a/doc/disorder_templates.5.head
+++ b/doc/disorder_templates.5.head
@@ -88,6 +88,9 @@ inclusion as a macro.
 Before any page is expanded, the CGI will process \fBmacros.tmpl\fR (and
 discard any output).
 This defines a collection of commonly used macros.
+.SS "Search Path"
+Template files a first searched for in \fIpkgconfdir\fR and then in
+\fIpkgdatadir\fR.
 .SH EXPANSIONS
 This section lists the supported expansions.
 .\" Local Variables: