X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=04c6b35878b5b4cd47969b3a732b4d26858dcbc1;hb=2968a77518b7c7cae5df702233dc83e4a559c3a9;hp=28fa7574ed9d6d2c4f6ad0a528fa55caf01662c2;hpb=cf35d38e7f845393659dfce0249a76d529a2c92c;p=public-inbox.git

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 28fa7574..04c6b358 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -2,10 +2,25 @@
 # 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')
+MAN = man
+XMLSTARLET = xmlstarlet
+
+# 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,11 +32,16 @@ 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-init
+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
@@ -71,38 +91,90 @@ manuals += $(m8)
 
 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
 docs += $(mantxt)
+dtxt += $(mantxt)
+docs += NEWS
 
-all :: $(mantxt)
+all :: $(docs)
 
 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 $(<F))" $(txt2pre)
+Documentation/standards.txt : Documentation/standards.perl
+	$(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@
+
+RELEASES =
+RELEASES += v1.1.0-pre1
+RELEASES += v1.0.0
+
+NEWS NEWS.atom NEWS.html : Documentation/RelNotes
+	$(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
+
+# check for internal API changes:
+check :: NEWS check-NEWS.atom NEWS.html
+
+check-NEWS.atom: NEWS.atom
+	$(XMLSTARLET) val $<; e=$$?; test $$e -eq 0 || test $$e -eq 127
+
+Documentation/%.html: Documentation/%.txt
+	$(txt2pre)
+
 %.html: %
 	$(txt2pre)
 
-docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt))
+docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt)) NEWS.html
 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) NEWS.atom NEWS.atom.gz
+
+# 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:
+	mkdir -p $@
+
+Documentation/.x/%.txt :: | Documentation/.x
+	$(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)
-rsync-doc:
-	git set-file-times $(docs) $(txt)
-	$(MAKE) gz-doc
-	$(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
+
+gz-xdoc: $(gz_xdocs)
+
+rsync-doc: NEWS.atom.gz
+	# /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) NEWS NEWS.atom NEWS.html
 
 clean :: clean-doc
+
+pure_all ::
+	@if test x"$(addprefix g, make)" != xgmake; then \
+	echo W: gmake is currently required to build manpages; fi