From 51c8178c0dda34d89f73eae2de2b73abedb6b877 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 4 Jan 2016 22:18:57 +0000 Subject: use Perl POD instead of pandoc-flavored Markdown This project is currently implemented in Perl, and pod2man is probably more common among potential users and developers of this project. --- Documentation/include.mk | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'Documentation/include.mk') diff --git a/Documentation/include.mk b/Documentation/include.mk index 694416ef..4669ac54 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 -- cgit v1.2.3-24-ge0c7