X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=149f9e3ce42e4a40ce66426d187ae7321c606079;hb=1f1b1f0e22f7b4cbe5c8e843c1932222c0461393;hp=651fdf30922b1f513b7c9de3afa17847af8db3ae;hpb=8816eccfbe6c9a1a046fd6db4ece45966e009307;p=public-inbox.git diff --git a/Documentation/include.mk b/Documentation/include.mk index 651fdf30..149f9e3c 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -1,29 +1,22 @@ -# Copyright (C) 2013-2019 all contributors +# Copyright (C) 2013-2021 all contributors # License: AGPL-3.0+ all:: -# Note: some GNU-isms present and required to build docs -# (including manpages), but at least this should not trigger -# warnings with BSD make(1) when running "make check" -# 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 +LEXGROG = lexgrog # this is "xml" on FreeBSD and maybe some other distros: XMLSTARLET = xmlstarlet +# libgraph-easy-perl from Debian, Graph::Easy from CPAN +GRAPH_EASY = graph-easy + # 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 -dtxt += standards.txt -dtxt := $(addprefix Documentation/, $(dtxt)) -docs := $(txt) $(dtxt) - INSTALL = install PODMAN = pod2man PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual' @@ -33,36 +26,7 @@ PODTEXT = pod2text PODTEXT_OPTS = --stderr 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 = -m5 += public-inbox-config -m5 += public-inbox-v1-format -m5 += public-inbox-v2-format -m7 = -m7 += public-inbox-overview -m8 = -m8 += public-inbox-daemon - -man1 := $(addsuffix .1, $(m1)) -man5 := $(addsuffix .5, $(m5)) -man7 := $(addsuffix .7, $(m7)) -man8 := $(addsuffix .8, $(m8)) - -all:: man html +all:: man manpages = $(man1) $(man5) $(man7) $(man8) @@ -70,108 +34,67 @@ 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 - $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir) + $(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)$(man1dir) + $(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 -%.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 = $(AWK) \ + '{gsub(/\b./,"")}$$0 !~ /\.onion/&&length>80{print;e=1}END{exit(e)}' \ + >&2 -check-man :: $(addprefix .,$(addsuffix .cols, $(manpages))) +check-man :: $(check_80) -manuals := -manuals += $(m1) -manuals += $(m5) -manuals += $(m7) -manuals += $(m8) - -mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals))) -docs += $(mantxt) -dtxt += $(mantxt) -docs += NEWS +check-lexgrog :: $(check_lexgrog) all :: $(docs) -Documentation/%.txt : Documentation/%.pod - $(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@ - -txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \ - touch -r $< $@+ && mv $@+ $@ +txt2pre = $(PERL) -I lib ./Documentation/txt2pre >$@ Documentation/standards.txt : Documentation/standards.perl - $(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@ + $(PERL) -w Documentation/standards.perl >$@+ + touch -r Documentation/standards.perl $@+ + mv $@+ $@ -RELEASES = -RELEASES += v1.2.0 -RELEASES += v1.1.0-pre1 -RELEASES += v1.0.0 +# flow.txt is checked into git since Graph::Easy isn't in many distros +Documentation/flow.txt : Documentation/flow.ge + (sed -ne '1,/^$$/p' $@+ + touch -r Documentation/flow.ge $@+ + mv $@+ $@ + +Documentation/lei-q.pod : lib/PublicInbox/Search.pm Documentation/common.perl + $(PERL) -I lib -w Documentation/common.perl $@ -NEWS NEWS.atom NEWS.html : Documentation/include.mk +NEWS NEWS.atom NEWS.html : $(news_deps) $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES) # check for internal API changes: -check :: NEWS check-NEWS.atom NEWS.html +check :: NEWS .NEWS.atom.check NEWS.html -check-NEWS.atom: NEWS.atom +.NEWS.atom.check: 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)) NEWS.html html: $(docs_html) -gz_docs := $(addsuffix .gz, $(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) @@ -192,26 +115,23 @@ rsync-doc: NEWS.atom.gz $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST) clean-doc: - $(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 + $(RM_F) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) \ + $(mantxt) $(rsync_xdocs) \ + NEWS NEWS.atom NEWS.html Documentation/standards.txt \ + Documentation/flow.html Documentation/flow.html.gz \ + Documentation/flow.txt.gz 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 +# this may not always be a Perl project. This should match what +# cgit generate, since git maintainers ensure git-archive has +# stable tar output +DIST_TREE = HEAD^{tree} +DIST_VER = +git-dist : + ver=$$(git describe $(DIST_VER) | sed -ne s/v//p); \ + pkgpfx=public-inbox-$$ver; \ + git archive --prefix=$$pkgpfx/ --format=tar $(DIST_TREE) \ + | gzip -n >$$pkgpfx.tar.gz; \ + echo $$pkgpfx.tar.gz created