doc: use local modules to generate NEWS*

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

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 5c5b473cb9ddf08ceb4a6e24d21564fedc5c3558..04c6b35878b5b4cd47969b3a732b4d26858dcbc1 100644 (file)
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -8,6 +8,12 @@ all::
 # Maybe it's not worth it to support non-GNU make, though...
 RSYNC = rsync
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
+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
@@ -27,8 +33,11 @@ podtext = $(PODTEXT) $(PODTEXT_OPTS)
 # MakeMaker only seems to support manpage sections 1 and 3...
 m1 =
 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
@@ -83,17 +92,31 @@ 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 $@+ $@
 
 Documentation/standards.txt : Documentation/standards.perl
-       $(PERL) $< >$@+ && mv $@+ $@
+       $(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)
@@ -101,10 +124,32 @@ Documentation/%.html: Documentation/%.txt
 %.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) $(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)
 
@@ -114,14 +159,19 @@ doc: $(docs)
        mv $@+ $@
 
 gz-doc: $(gz_docs)
-rsync-doc:
+
+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
-       $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST)
+       $(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