X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=8501adc86873393e9c89aa82c91ecbd23a64c72f;hb=d9aad3a7988262b31ab2171f2c982daf04ac822c;hp=c028eef65e5770fc7432905bf37268ba5de8ef8d;hpb=115faab9fa75a36cf03ff83496221cae827e19d4;p=public-inbox.git
diff --git a/Documentation/include.mk b/Documentation/include.mk
index c028eef6..8501adc8 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,11 +1,25 @@
-# Copyright (C) 2013-2015 all contributors
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2013-2019 all contributors
+# License: AGPL-3.0+
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')
+MAN = man
+
+# same as pod2text
+COLUMNS = 76
+
+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'
@@ -17,13 +31,19 @@ podtext = $(PODTEXT) $(PODTEXT_OPTS)
# MakeMaker only seems to support manpage sections 1 and 3...
m1 =
-m1 += public-inbox-mda
+m1 += public-inbox-compact
+m1 += public-inbox-convert
+m1 += public-inbox-edit
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 =
@@ -69,38 +89,74 @@ manuals += $(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 hosted.txt
-dtxt := $(addprefix Documentation/, $(dtxt)) $(mantxt)
-%.html: %.txt
- TITLE="$(basename $($@+ && 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)
+
+# external manpages which we host ourselves, since some packages
+# (currently just Xapian) doesn't host manpages themselves.
+xtxt :=
+xtxt += .copydatabase.1
+xtxt += .xapian-compact.1
+xtxt := $(addprefix Documentation/.x/, $(addsuffix .txt, $(xtxt)))
+xdocs := $(xtxt)
+xdocs_html := $(addsuffix .html, $(subst .txt,,$(xtxt)))
+gz_xdocs := $(addsuffix .gz, $(xdocs) $(xdocs_html))
+rsync_xdocs := $(gz_xdocs) $(xdocs_html) $(xdocs)
+xdoc: $(xdocs) $(xdocs_html)
+
+Documentation/.x/%.txt::
+ @-mkdir -p $(@D)
+ $(PERL) -w Documentation/extman.perl $@ >$@+
+ mv $@+ $@
+
+Documentation/.x/%.html: Documentation/.x/%.txt
+ $(txt2pre)
+
+doc: $(docs)
+
%.gz: %
gzip -9 --rsyncable <$< >$@+
touch -r $< $@+
mv $@+ $@
gz-doc: $(gz_docs)
+
+gz-xdoc: $(gz_xdocs)
+
rsync-doc:
- git set-file-times $(docs) $(txt)
- $(MAKE) gz-doc
- $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
+ # /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 gz-xdoc
+ $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST)
+
clean-doc:
- $(RM) $(man1) $(man5) $(man7) $(gz_docs) $(docs_html) $(mantxt)
+ $(RM) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) $(mantxt)
+ $(RM) $(gz_xdocs) $(xdocs_html) $(xdocs)
clean :: clean-doc
+
+pure_all ::
+ @if test x"$(addprefix g, make)" != xgmake; then \
+ echo W: gmake is currently required to build manpages; fi