-# Copyright (C) 2013-2015 all contributors <meta@public-inbox.org>
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2013-2019 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
all::
+# Note: some GNU-isms present and required to build docs
+# (including manpages), but at least this should not trigger
+# warnings with BSD make(1) when running "make check"
+# Maybe it's not worth it to support non-GNU make, though...
RSYNC = rsync
RSYNC_DEST = public-inbox.org:/srv/public-inbox/
-docs := README COPYING INSTALL TODO HACKING
-docs += $(shell git ls-files 'Documentation/*.txt')
+txt := INSTALL README COPYING TODO HACKING
+dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
+dtxt += marketing.txt
+dtxt += standards.txt
+dtxt := $(addprefix Documentation/, $(dtxt))
+docs := $(txt) $(dtxt)
+
INSTALL = install
PODMAN = pod2man
PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
# MakeMaker only seems to support manpage sections 1 and 3...
m1 =
-m1 += public-inbox-mda
+m1 += public-inbox-compact
m1 += public-inbox-httpd
+m1 += public-inbox-index
+m1 += public-inbox-mda
m1 += public-inbox-nntpd
m1 += public-inbox-watch
-m1 += public-inbox-index
+m1 += public-inbox-xcpdb
m5 =
m5 += public-inbox-config
+m5 += public-inbox-v1-format
+m5 += public-inbox-v2-format
m7 =
m7 += public-inbox-overview
m8 =
mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
docs += $(mantxt)
+dtxt += $(mantxt)
all :: $(mantxt)
Documentation/%.txt : Documentation/%.pod
- $(podtext) $< $@+ && mv $@+ $@
+ $(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@
txt2pre = $(PERL) -I lib ./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)
-%.html: %.txt
- TITLE="$(basename $(<F))" $(txt2pre)
+Documentation/standards.txt : Documentation/standards.perl
+ $(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@
+
+Documentation/%.html: Documentation/%.txt
+ $(txt2pre)
+
%.html: %
$(txt2pre)
docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
html: $(docs_html)
gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
-rsync_docs := $(gz_docs) $(docs) $(txt) $(docs_html)
+rsync_docs := $(gz_docs) $(docs) $(docs_html)
+
+doc: $(docs)
+
%.gz: %
gzip -9 --rsyncable <$< >$@+
touch -r $< $@+
gz-doc: $(gz_docs)
rsync-doc:
- git set-file-times $(docs) $(txt)
+ # /usr/share/doc/rsync/scripts/git-set-file-times{.gz} on Debian systems
+ # It is also at: https://yhbt.net/git-set-file-times
+ -git set-file-times $(docs) $(txt)
$(MAKE) gz-doc
$(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
clean-doc:
$(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
clean :: clean-doc
+
+pure_all ::
+ @if test x"$(addprefix g, make)" != xgmake; then \
+ echo W: gmake is currently required to build manpages; fi