[PATCH] use Perl POD instead of pandoc-flavored Markdown

[PATCH] use Perl POD instead of pandoc-flavored Markdown

[Eric Wong]

This project is currently implemented in Perl, and pod2man is
probably more common among potential users and developers of
this project.
---
 Documentation/.gitignore                           |  1 +
 Documentation/include.mk                           | 30 ++++++++++++++------
 .../{public-inbox-mda.txt => public-inbox-mda.pod} | 32 ++++++++++++++++------
 MANIFEST                                           |  2 +-
 4 files changed, 48 insertions(+), 17 deletions(-)
 create mode 100644 Documentation/.gitignore
 rename Documentation/{public-inbox-mda.txt => public-inbox-mda.pod} (34%)

diff --git a/Documentation/.gitignore b/Documentation/.gitignore
new file mode 100644
index 0000000..8ba4186
--- /dev/null
+++ b/Documentation/.gitignore
@@ -0,0 +1 @@
+/public-inbox-mda.txt
diff --git a/Documentation/include.mk b/Documentation/include.mk
index 694416e..4669ac5 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -6,9 +6,12 @@ RSYNC = rsync
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
 docs := README COPYING INSTALL TODO $(shell git ls-files 'Documentation/*.txt')
 INSTALL = install
-PANDOC = pandoc
-PANDOC_OPTS = -f markdown --email-obfuscation=none
-pandoc = $(PANDOC) $(PANDOC_OPTS)
+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)
 
 m1 =
 m1 += public-inbox-mda
@@ -36,13 +39,22 @@ install-man: man
 	test -z "$(man1)" || $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
 	test -z "$(man5)" || $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
 	test -z "$(man7)" || $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
-%.1 %.5 %.7 : Documentation/%.txt
-	$(pandoc) -s -t man < $< > $@+ && mv $@+ $@
+
+%.1 : Documentation/%.pod
+	$(pod2man) -s 1 $< $@+ && mv $@+ $@
+
+mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(m1)))
+docs += $(mantxt)
+
+all :: $(mantxt)
+
+Documentation/%.txt : Documentation/%.pod
+	$(pod2text) $< $@+ && 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))
+dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt
+dtxt := $(addprefix Documentation/, $(dtxt)) $(mantxt)
 
 %.html: %.txt
 	$(txt2pre)
@@ -64,4 +76,6 @@ rsync-doc:
 	$(MAKE) gz-doc
 	$(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
 clean-doc:
-	$(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html)
+	$(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
+
+clean :: clean-doc
diff --git a/Documentation/public-inbox-mda.txt b/Documentation/public-inbox-mda.pod
similarity index 34%
rename from Documentation/public-inbox-mda.txt
rename to Documentation/public-inbox-mda.pod
index 8e33e02..80bb349 100644
--- a/Documentation/public-inbox-mda.txt
+++ b/Documentation/public-inbox-mda.pod
@@ -1,20 +1,36 @@
 % public-inbox-mda(1) public-inbox user manual
 
-# NAME
+=head1 NAME
 
 public-inbox-mda - mail delivery for public-inbox
 
-# SYNOPSIS
+=head1 SYNOPSIS
+
+B<public-inbox-mda> E<lt> message
+
+=head1 DESCRIPTION
 
 Mail Delivery Agent (MDA) for public-inbox installations.
 Each system user may have their own public-inbox instances
 
-# ENVIRONMENT
+=head1 ENVIRONMENT
+
+=over 8
+
+=item ORIGINAL_RECIPIENT
+
+the original recipient email address, from Postfix
+
+=item PI_CONFIG
+
+config file. default: ~/.public-inbox/config
+
+=item PI_EMERGENCY
+
+emergency destination.  default: ~/.public-inbox/emergency/
 
-* ORIGINAL_RECIPIENT - the original recipient email address, from Postfix
-* PI_CONFIG - config file. default: ~/.public-inbox/config
-* PI_EMERGENCY - emergency destination.  default: ~/.public-inbox/emergency/
+=back
 
-# PI_CONFIG FILE
+=head1 PI_CONFIG FILE
 
-This is a config file parseable by git-config(1).
+This is a config file parseable by L<git-config(1)>.
diff --git a/MANIFEST b/MANIFEST
index 5d45046..e11afc8 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -4,7 +4,7 @@ Documentation/dc-dlvr-spam-flow.txt
 Documentation/design_notes.txt
 Documentation/design_www.txt
 Documentation/include.mk
-Documentation/public-inbox-mda.txt
+Documentation/public-inbox-mda.pod
 Documentation/txt2pre
 HACKING
 INSTALL
-- 
EW