[PATCH 0/4] preliminary doc updates

[PATCH 0/4] preliminary doc updates

[Eric Wong]

Actual documentation is coming...

Eric Wong (4):
      README: add link to source code mirrors
      doc: mda: remove vestigial pandoc comment
      avoid spaces after shell redirection operators
      doc: avoid conflicting with MakeMaker variable names

 Documentation/include.mk           | 20 ++++++++++----------
 Documentation/public-inbox-mda.pod |  4 +---
 README                             |  3 +++
 scripts/dc-dlvr                    |  4 ++--
 scripts/dc-dlvr.pre                |  6 +++---
 scripts/report-spam                |  8 ++++----
 6 files changed, 23 insertions(+), 22 deletions(-)

[PATCH 1/4] README: add link to source code mirrors

[Eric Wong]

Centralization sucks, so we mirror everything.
---
 README | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README b/README
index 7618727..3235275 100644
--- a/README
+++ b/README
@@ -88,6 +88,8 @@ Hacking
 Source code is available via git:
 
 	git clone https://public-inbox.org/ public-inbox
+	git clone git://repo.or.cz/public-inbox
+	torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
 
 See below for contact info.
 
@@ -119,6 +121,7 @@ And as Tor hidden services:
 You may also clone all messages via git:
 
 	git clone --mirror https://public-inbox.org/meta/
+	torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/
 
 Or pass the same git repository URL for ssoma using the instructions at:
 
-- 
EW

[PATCH 2/4] doc: mda: remove vestigial pandoc comment

[Eric Wong]

We use perlpod nowadays since it's Perl, like our code base.
---
 Documentation/public-inbox-mda.pod | 2 --
 1 file changed, 2 deletions(-)

diff --git a/Documentation/public-inbox-mda.pod b/Documentation/public-inbox-mda.pod
index cb17471..62f87d6 100644
--- a/Documentation/public-inbox-mda.pod
+++ b/Documentation/public-inbox-mda.pod
@@ -1,5 +1,3 @@
-% public-inbox-mda(1) public-inbox user manual
-
 =head1 NAME
 
 public-inbox-mda - mail delivery for public-inbox
-- 
EW

[PATCH 3/4] avoid spaces after shell redirection operators

[Eric Wong]

This makes us closer to git.git style (though I'm not quite sure
why we do this...)
---
 Documentation/include.mk           | 4 ++--
 Documentation/public-inbox-mda.pod | 2 +-
 scripts/dc-dlvr                    | 4 ++--
 scripts/dc-dlvr.pre                | 6 +++---
 scripts/report-spam                | 8 ++++----
 5 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 396a258..bd9df8c 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -52,7 +52,7 @@ all :: $(mantxt)
 Documentation/%.txt : Documentation/%.pod
 	$(pod2text) $< $@+ && mv $@+ $@
 
-txt2pre = ./Documentation/txt2pre < $< > $@+ && touch -r $< $@+ && mv $@+ $@
+txt2pre = ./Documentation/txt2pre <$< >$@+ && touch -r $< $@+ && mv $@+ $@
 txt := INSTALL README COPYING TODO
 dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt
 dtxt := $(addprefix Documentation/, $(dtxt)) $(mantxt)
@@ -67,7 +67,7 @@ html: $(docs_html)
 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
 rsync_docs := $(gz_docs) $(docs) $(txt) $(docs_html)
 %.gz: %
-	gzip -9 --rsyncable < $< > $@+
+	gzip -9 --rsyncable <$< >$@+
 	touch -r $< $@+
 	mv $@+ $@
 
diff --git a/Documentation/public-inbox-mda.pod b/Documentation/public-inbox-mda.pod
index 62f87d6..18fcdd0 100644
--- a/Documentation/public-inbox-mda.pod
+++ b/Documentation/public-inbox-mda.pod
@@ -4,7 +4,7 @@ public-inbox-mda - mail delivery for public-inbox
 
 =head1 SYNOPSIS
 
-B<public-inbox-mda> E<lt> message
+B<public-inbox-mda> E<lt>MESSAGE
 
 =head1 DESCRIPTION
 
diff --git a/scripts/dc-dlvr b/scripts/dc-dlvr
index a38760f..81193b2 100755
--- a/scripts/dc-dlvr
+++ b/scripts/dc-dlvr
@@ -57,14 +57,14 @@ err=$?
 set -e
 
 case $err in
-1) $DELIVER -m INBOX.spam < $TMPMSG ;;
+1) $DELIVER -m INBOX.spam <$TMPMSG ;;
 *)
 	# users may override normal delivery and have it go elsewhere
 	if test -r ~/.dc-dlvr.rc
 	then
 		. ~/.dc-dlvr.rc
 	else
-		$DELIVER -m INBOX < $TMPMSG
+		$DELIVER -m INBOX <$TMPMSG
 	fi
 	;;
 esac
diff --git a/scripts/dc-dlvr.pre b/scripts/dc-dlvr.pre
index c10e80c..d7bc1b5 100644
--- a/scripts/dc-dlvr.pre
+++ b/scripts/dc-dlvr.pre
@@ -5,7 +5,7 @@
 export PATH=/usr/local/bin:/usr/bin:/bin
 trap 'err=$?; set +e; test $err -eq 0 || rm -f $TMPMSG; exit $err' EXIT
 case $1,$CLIENT_ADDRESS in
-pispam,) exec public-inbox-learn spam < $TMPMSG ;;
-piham,) exec public-inbox-learn ham < $TMPMSG ;;
+pispam,) exec public-inbox-learn spam <$TMPMSG ;;
+piham,) exec public-inbox-learn ham <$TMPMSG ;;
 esac
-exec public-inbox-mda < $TMPMSG
+exec public-inbox-mda <$TMPMSG
diff --git a/scripts/report-spam b/scripts/report-spam
index 0015ef0..325f571 100755
--- a/scripts/report-spam
+++ b/scripts/report-spam
@@ -32,14 +32,14 @@ PI_USER=pi
 
 case $1 in
 *[/.]spam/cur/*) # non-new messages in spam get trained
-	$DO_SENDMAIL $PI_USER+pispam < $1
-	exec $DO_SENDMAIL $USER+trainspam < $1
+	$DO_SENDMAIL $PI_USER+pispam <$1
+	exec $DO_SENDMAIL $USER+trainspam <$1
 	;;
 *:2,*S*) # otherwise, seen messages only
 	case $1 in
 	*:2,*T*) exit 0 ;; # ignore trashed messages
 	esac
-	$DO_SENDMAIL $PI_USER+piham < $1
-	exec $DO_SENDMAIL $USER+trainham < $1
+	$DO_SENDMAIL $PI_USER+piham <$1
+	exec $DO_SENDMAIL $USER+trainham <$1
 	;;
 esac
-- 
EW

[PATCH 4/4] doc: avoid conflicting with MakeMaker variable names

[Eric Wong]

We want the pod2man(1) executable for handling certain
options.  Also, use the correct year while we're at it :P
---
 Documentation/include.mk | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/include.mk b/Documentation/include.mk
index bd9df8c..5d73028 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -7,12 +7,12 @@ RSYNC_DEST = public-inbox.org:/srv/public-inbox/
 docs := README COPYING INSTALL TODO HACKING
 docs += $(shell git ls-files 'Documentation/*.txt')
 INSTALL = install
-POD2MAN ?= pod2man
-POD2MAN_OPTS = -v --stderr -d 1994-10-02 -c 'public-inbox user manual'
-pod2man = $(POD2MAN) $(POD2MAN_OPTS)
-POD2TEXT = pod2text
-POD2TEXT_OPTS = --stderr
-pod2text = $(POD2TEXT) $(POD2TEXT_OPTS)
+PODMAN = pod2man
+PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
+podman = $(PODMAN) $(PODMAN_OPTS)
+PODTEXT = pod2text
+PODTEXT_OPTS = --stderr
+podtext = $(PODTEXT) $(PODTEXT_OPTS)
 
 m1 =
 m1 += public-inbox-mda
@@ -42,7 +42,7 @@ install-man: man
 	test -z "$(man7)" || $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
 
 %.1 : Documentation/%.pod
-	$(pod2man) -s 1 $< $@+ && mv $@+ $@
+	$(podman) -s 1 $< $@+ && mv $@+ $@
 
 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(m1)))
 docs += $(mantxt)
@@ -50,7 +50,7 @@ docs += $(mantxt)
 all :: $(mantxt)
 
 Documentation/%.txt : Documentation/%.pod
-	$(pod2text) $< $@+ && mv $@+ $@
+	$(podtext) $< $@+ && mv $@+ $@
 
 txt2pre = ./Documentation/txt2pre <$< >$@+ && touch -r $< $@+ && mv $@+ $@
 txt := INSTALL README COPYING TODO
-- 
EW