X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=149f9e3ce42e4a40ce66426d187ae7321c606079;hb=1f1b1f0e22f7b4cbe5c8e843c1932222c0461393;hp=28b69aeda1f719363f4c2227108d8924ecd603a1;hpb=46174e0f8c151dfb5a42723c865b4893f66e73b0;p=public-inbox.git diff --git a/Documentation/include.mk b/Documentation/include.mk index 28b69aed..149f9e3c 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -1,11 +1,22 @@ -# Copyright (C) 2013-2015 all contributors -# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt) +# Copyright (C) 2013-2021 all contributors +# License: AGPL-3.0+ 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 +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 + INSTALL = install PODMAN = pod2man PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual' @@ -15,92 +26,112 @@ PODTEXT = pod2text PODTEXT_OPTS = --stderr podtext = $(PODTEXT) $(PODTEXT_OPTS) -# MakeMaker only seems to support manpage sections 1 and 3... -m1 = -m1 += public-inbox-mda -m1 += public-inbox-httpd -m1 += public-inbox-nntpd -m1 += public-inbox-watch -m1 += public-inbox-index -m5 = -m5 += public-inbox-config -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 - -man: $(man1) $(man5) $(man7) $(man8) +all:: man + +manpages = $(man1) $(man5) $(man7) $(man8) + +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 = $(AWK) \ + '{gsub(/\b./,"")}$$0 !~ /\.onion/&&length>80{print;e=1}END{exit(e)}' \ + >&2 + +check-man :: $(check_80) + +check-lexgrog :: $(check_lexgrog) + +all :: $(docs) -manuals := -manuals += $(m1) -manuals += $(m5) -manuals += $(m7) -manuals += $(m8) +txt2pre = $(PERL) -I lib ./Documentation/txt2pre >$@ -mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals))) -docs += $(mantxt) +Documentation/standards.txt : Documentation/standards.perl + $(PERL) -w Documentation/standards.perl >$@+ + touch -r Documentation/standards.perl $@+ + mv $@+ $@ + +# 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 $@+ $@ -all :: $(mantxt) +Documentation/lei-q.pod : lib/PublicInbox/Search.pm Documentation/common.perl + $(PERL) -I lib -w Documentation/common.perl $@ -Documentation/%.txt : Documentation/%.pod - $(podtext) $< $@+ && mv $@+ $@ +NEWS NEWS.atom NEWS.html : $(news_deps) + $(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 - TITLE="$(basename $($@ -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) + +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 \ + Documentation/flow.html Documentation/flow.html.gz \ + Documentation/flow.txt.gz clean :: clean-doc + +# No camel-cased tarballs or pathnames which MakeMaker creates, +# 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