Merge remote-tracking branch 'origin/xap-optional' into master

[public-inbox.git] / Documentation / include.mk

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 9d2c3b09dd83e29a97a8d80289be5e120fe855af..6415338b9158ff0ff5340e0728d598b4b51ea3dd 100644 (file)
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,11 +1,20 @@
-# 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'
@@ -15,38 +24,63 @@ PODTEXT = pod2text
 PODTEXT_OPTS = --stderr
 podtext = $(PODTEXT) $(PODTEXT_OPTS)
 
+# MakeMaker only seems to support manpage sections 1 and 3...
 m1 =
 m1 += public-inbox-mda
+m1 += public-inbox-httpd
+m1 += public-inbox-nntpd
+m1 += public-inbox-watch
+m1 += public-inbox-index
 m5 =
+m5 += public-inbox-config
+m5 += public-inbox-v1-format
+m5 += public-inbox-v2-format
 m7 =
+m7 += public-inbox-overview
+m8 =
+m8 += public-inbox-daemon
 
 man1 := $(addsuffix .1, $(m1))
 man5 := $(addsuffix .5, $(m5))
 man7 := $(addsuffix .7, $(m7))
+man8 := $(addsuffix .8, $(m8))
 
 all:: man html
 
-man: $(man1) $(man5) $(man7)
+man: $(man1) $(man5) $(man7) $(man8)
 
+prefix ?= $(PREFIX)
 prefix ?= $(HOME)
 mandir ?= $(prefix)/share/man
 man1dir = $(mandir)/man1
 man5dir = $(mandir)/man5
 man7dir = $(mandir)/man7
+man8dir = $(mandir)/man8
 
 install-man: man
-       test -z "$(man1)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
-       test -z "$(man5)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
-       test -z "$(man7)" || $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
-       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)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
+       $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
+       $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
+       $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
+       $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
+       $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
+
+doc_install :: install-man
 
 %.1 %.5 %.7 %.8 : Documentation/%.pod
        $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
 
-mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(m1)))
+manuals :=
+manuals += $(m1)
+manuals += $(m5)
+manuals += $(m7)
+manuals += $(m8)
+
+mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
 docs += $(mantxt)
+dtxt += $(mantxt)
 
 all :: $(mantxt)
 
@@ -55,19 +89,23 @@ Documentation/%.txt : Documentation/%.pod
 
 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) $< >$@+ && 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 $< $@+
@@ -82,3 +120,7 @@ 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