public-inbox v1.2.0

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

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 5c5b473cb9ddf08ceb4a6e24d21564fedc5c3558..ea0498c19f05b7e5878b32ce40b0901d10c85104 100644 (file)
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -8,6 +8,15 @@ all::
 # Maybe it's not worth it to support non-GNU make, though...
 RSYNC = rsync
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
+AWK = awk
+MAN = man
+
+# this is "xml" on FreeBSD and maybe some other distros:
+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,10 +36,16 @@ 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.cgi
+m1 += public-inbox-edit
 m1 += public-inbox-httpd
 m1 += public-inbox-index
+m1 += public-inbox-init
+m1 += public-inbox-learn
 m1 += public-inbox-mda
 m1 += public-inbox-nntpd
+m1 += public-inbox-purge
 m1 += public-inbox-watch
 m1 += public-inbox-xcpdb
 m5 =
@@ -49,7 +64,9 @@ man8 := $(addsuffix .8, $(m8))
 
 all:: man html
 
-man: $(man1) $(man5) $(man7) $(man8)
+manpages = $(man1) $(man5) $(man7) $(man8)
+
+man: $(manpages)
 
 prefix ?= $(PREFIX)
 prefix ?= $(HOME)
@@ -74,6 +91,17 @@ doc_install :: install-man
 %.1 %.5 %.7 %.8 : Documentation/%.pod
        $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
 
+check :: check-man
+check_man = @echo CHECK80 $<;COLUMNS=80 $(MAN) ./$^ | \
+       $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}' >&2
+
+%.1.cols : %.1; $(check_man)
+%.5.cols : %.5; $(check_man)
+%.7.cols : %.7; $(check_man)
+%.8.cols : %.8; $(check_man)
+
+check-man :: $(addsuffix .cols, $(manpages))
+
 manuals :=
 manuals += $(m1)
 manuals += $(m5)
@@ -83,17 +111,33 @@ 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.2.0
+RELEASES += v1.1.0-pre1
+RELEASES += v1.0.0
+
+NEWS NEWS.atom NEWS.html : Documentation/include.mk
+       $(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 NEWS.atom || \
+               { e=$$?; test $$e -eq 0 || test $$e -eq 127; }
 
 Documentation/%.html: Documentation/%.txt
        $(txt2pre)
@@ -101,10 +145,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,17 +180,37 @@ 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)
+       $(RM) NEWS NEWS.atom NEWS.html Documentation/standards.txt
 
 clean :: clean-doc
 
 pure_all ::
        @if test x"$(addprefix g, make)" != xgmake; then \
        echo W: gmake is currently required to build manpages; fi
+
+# No camel-cased tarballs or pathnames which MakeMaker creates,
+# this may not always be a Perl project.
+git-dist :: ver = $(shell git describe |sed -ne 's/v//p')
+git-dist :: pkgpfx := public-inbox-$(ver)
+git-dist :: NEWS
+       git archive --prefix=$(pkgpfx)/ --format=tar HEAD^{tree} >$(pkgpfx).tar
+       mkdir -p $(pkgpfx)
+       cp NEWS $(pkgpfx)/NEWS
+       $(TAR) rf $(pkgpfx).tar $(pkgpfx)/NEWS
+       $(RM) $(pkgpfx)/NEWS
+       rmdir $(pkgpfx)
+       gzip -9 $(pkgpfx).tar
+       @echo $(pkgpfx).tar.gz created