X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=blobdiff_plain;f=Documentation%2Finclude.mk;h=ea0498c19f05b7e5878b32ce40b0901d10c85104;hp=04c6b35878b5b4cd47969b3a732b4d26858dcbc1;hb=4821798351defce82c102e46d6f5f84f0cdc0e34;hpb=2968a77518b7c7cae5df702233dc83e4a559c3a9 diff --git a/Documentation/include.mk b/Documentation/include.mk index 04c6b358..ea0498c1 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -8,7 +8,10 @@ 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 @@ -34,12 +37,15 @@ podtext = $(PODTEXT) $(PODTEXT_OPTS) 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 = @@ -58,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) @@ -83,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) @@ -106,17 +125,19 @@ Documentation/standards.txt : Documentation/standards.perl $(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@ RELEASES = +RELEASES += v1.2.0 RELEASES += v1.1.0-pre1 RELEASES += v1.0.0 -NEWS NEWS.atom NEWS.html : Documentation/RelNotes +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 $<; e=$$?; test $$e -eq 0 || test $$e -eq 127 + $(XMLSTARLET) val NEWS.atom || \ + { e=$$?; test $$e -eq 0 || test $$e -eq 127; } Documentation/%.html: Documentation/%.txt $(txt2pre) @@ -171,10 +192,25 @@ rsync-doc: NEWS.atom.gz clean-doc: $(RM) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) $(mantxt) - $(RM) $(gz_xdocs) $(xdocs_html) $(xdocs) NEWS NEWS.atom NEWS.html + $(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