X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=f2605346ad495b9fb16d8f7799da007ef80a4ad8;hb=73fe3421f1ecbdc83600d5acfc643c33dbb9a0f2;hp=51a914b3e75588522d254764bc4aa363347c4b2c;hpb=dfb1ed795ba2890b710b3faee82db9ccdf888e17;p=public-inbox.git

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 51a914b3..f2605346 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,83 +1,123 @@
-# 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::
 
 RSYNC = rsync
 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
-docs := README COPYING INSTALL TODO HACKING
-docs += $(shell git ls-files 'Documentation/*.txt')
+AWK = awk
+MAN = man
+
+# this is "xml" on FreeBSD and maybe some other distros:
+XMLSTARLET = xmlstarlet
+
+# same as pod2text
+COLUMNS = 76
+
 INSTALL = install
 PODMAN = pod2man
 PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
+PODMAN_OPTS += -r public-inbox.git
 podman = $(PODMAN) $(PODMAN_OPTS)
 PODTEXT = pod2text
 PODTEXT_OPTS = --stderr
 podtext = $(PODTEXT) $(PODTEXT_OPTS)
 
-m1 =
-m1 += public-inbox-mda
-m5 =
-m7 =
-
-man1 := $(addsuffix .1, $(m1))
-man5 := $(addsuffix .5, $(m5))
-man7 := $(addsuffix .7, $(m7))
+all:: man
 
-all:: man html
+manpages = $(man1) $(man5) $(man7) $(man8)
 
-man: $(man1) $(man5) $(man7)
+man: $(manpages)
 
+prefix ?= $(PREFIX)
 prefix ?= $(HOME)
-mandir ?= $(prefix)/share/man
-man1dir = $(mandir)/man1
+mandir ?= $(INSTALLMAN1DIR)/..
 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)$(INSTALLMAN1DIR)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
+	$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
+	$(INSTALL) -m 644 $(man1) $(DESTDIR)$(INSTALLMAN1DIR)
+	$(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
+	$(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
+	$(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
+
+doc_install :: install-man
+
+check :: check-man
+check_man = $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}'\
+	>&2 && >$@
+
+check-man :: $(check_80)
+
+all :: $(docs)
 
-%.1 : Documentation/%.pod
-	$(podman) -s 1 $< $@+ && mv $@+ $@
+txt2pre = $(PERL) -I lib ./Documentation/txt2pre >$@
 
-mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(m1)))
-docs += $(mantxt)
+Documentation/standards.txt : Documentation/standards.perl
+	$(PERL) -w Documentation/standards.perl >$@+
+	touch -r Documentation/standards.perl $@+
+	mv $@+ $@
 
-all :: $(mantxt)
+RELEASES =
+RELEASES += v1.2.0
+RELEASES += v1.1.0-pre1
+RELEASES += v1.0.0
 
-Documentation/%.txt : Documentation/%.pod
-	$(podtext) $< $@+ && mv $@+ $@
+NEWS NEWS.atom NEWS.html : Documentation/include.mk
+	$(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
 
-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)
+# check for internal API changes:
+check :: NEWS .NEWS.atom.check NEWS.html
 
-%.html: %.txt
-	$(txt2pre)
-%.html: %
-	$(txt2pre)
+.NEWS.atom.check: NEWS.atom
+	$(XMLSTARLET) val NEWS.atom || \
+		{ e=$$?; test $$e -eq 0 || test $$e -eq 127; }
+	>$@
 
-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)
+
+Documentation/.x:
+	mkdir -p $@
+
+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_F) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) \
+		$(mantxt) $(rsync_xdocs) \
+		NEWS NEWS.atom NEWS.html Documentation/standards.txt
 
 clean :: clean-doc
+
+# 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