X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=07b9f2a3f414734105906ad0c08856c9891dc55a;hb=f8cc21f0064a34042d149f31097336919adf70d1;hp=8501adc86873393e9c89aa82c91ecbd23a64c72f;hpb=3c30532aed6256a984c535530c6667552c2e6a84;p=public-inbox.git

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 8501adc8..07b9f2a3 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -8,8 +8,13 @@ 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
+AWK = awk
+
 # same as pod2text
 COLUMNS = 76
 
@@ -36,6 +41,7 @@ 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
@@ -56,7 +62,9 @@ man8 := $(addsuffix .8, $(m8))
 
 all:: man html
 
-man: $(man1) $(man5) $(man7) $(man8)
+manpages = $(man1) $(man5) $(man7) $(man8)
+
+man: $(manpages)
 
 prefix ?= $(PREFIX)
 prefix ?= $(HOME)
@@ -81,6 +89,19 @@ doc_install :: install-man
 %.1 %.5 %.7 %.8 : Documentation/%.pod
 	$(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
 
+# n.b. not sure if our usage of man(1) is portable or not, so not
+# enabled by default "check" target:
+# 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)
@@ -90,8 +111,9 @@ manuals += $(m8)
 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
 docs += $(mantxt)
 dtxt += $(mantxt)
+docs += NEWS
 
-all :: $(mantxt)
+all :: $(docs)
 
 Documentation/%.txt : Documentation/%.pod
 	$(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@
@@ -102,16 +124,30 @@ txt2pre = $(PERL) -I lib ./Documentation/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 :
+	$(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)
 
 %.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.
@@ -125,8 +161,10 @@ gz_xdocs := $(addsuffix .gz, $(xdocs) $(xdocs_html))
 rsync_xdocs := $(gz_xdocs) $(xdocs_html) $(xdocs)
 xdoc: $(xdocs) $(xdocs_html)
 
-Documentation/.x/%.txt::
-	@-mkdir -p $(@D)
+Documentation/.x:
+	mkdir -p $@
+
+Documentation/.x/%.txt :: | Documentation/.x
 	$(PERL) -w Documentation/extman.perl $@ >$@+
 	mv $@+ $@
 
@@ -144,7 +182,7 @@ gz-doc: $(gz_docs)
 
 gz-xdoc: $(gz_xdocs)
 
-rsync-doc:
+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)
@@ -153,7 +191,7 @@ rsync-doc:
 
 clean-doc:
 	$(RM) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) $(mantxt)
-	$(RM) $(gz_xdocs) $(xdocs_html) $(xdocs)
+	$(RM) $(gz_xdocs) $(xdocs_html) $(xdocs) NEWS NEWS.atom NEWS.html
 
 clean :: clean-doc