diff options
Diffstat (limited to 'Documentation/include.mk')
| -rw-r--r-- | Documentation/include.mk | 50 |
1 files changed, 28 insertions, 22 deletions
diff --git a/Documentation/include.mk b/Documentation/include.mk index 207983f0..86851376 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2020 all contributors <meta@public-inbox.org> +# Copyright (C) all contributors <meta@public-inbox.org> # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt> all:: @@ -7,23 +7,22 @@ RSYNC_DEST = public-inbox.org:/srv/public-inbox/ AWK = awk MAN = man +# part of `man-db' on Debian, not sure about other distros +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' PODMAN_OPTS += -r public-inbox.git podman = $(PODMAN) $(PODMAN_OPTS) -PODTEXT = pod2text -PODTEXT_OPTS = --stderr -podtext = $(PODTEXT) $(PODTEXT_OPTS) + +man2text = COLUMNS=80 MANWIDTH=80 TERM=dumb MANOPT='--nj --nh' man all:: man @@ -50,11 +49,14 @@ install-man: man doc_install :: install-man -check :: check-man -check_man = $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}'\ - >&2 && >$@ +check : check-man +check_man = $(AWK) \ + '{gsub(/\b./,"")}$$0 !~ /\.onion/&&length>80{print;e=1}END{exit(e)}' \ + >&2 + +check-man : $(check_80) -check-man :: $(check_80) +check-lexgrog : $(check_lexgrog) all :: $(docs) @@ -67,20 +69,26 @@ Documentation/standards.txt : Documentation/standards.perl # flow.txt is checked into git since Graph::Easy isn't in many distros Documentation/flow.txt : Documentation/flow.ge - (sed -ne '1,/^$$/p' <Documentation/flow.ge; \ - $(GRAPH_EASY) Documentation/flow.ge || \ - cat Documentation/flow.txt; \ + +%.txt : %.ge + (sed -ne '1,/^$$/p' <$<; \ + $(GRAPH_EASY) $< || grep -v '^#' $@; \ echo; \ - sed -ne '/^# Copyright/,$$p' <Documentation/flow.ge \ + sed -ne '/^# Copyright/,$$p' <$< \ ) >$@+ - touch -r Documentation/flow.ge $@+ + echo >>$@+ \ + '# This file was generated from $(@F) using Graph::Easy' + touch -r $< $@+ mv $@+ $@ +Documentation/lei-q.pod : lib/PublicInbox/Search.pm Documentation/common.perl + $(PERL) -I lib -w Documentation/common.perl $@ + NEWS NEWS.atom NEWS.html : $(news_deps) $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES) # check for internal API changes: -check :: NEWS .NEWS.atom.check NEWS.html +check : NEWS .NEWS.atom.check NEWS.html .NEWS.atom.check: NEWS.atom $(XMLSTARLET) val NEWS.atom || \ @@ -98,18 +106,16 @@ doc: $(docs) gz-doc: $(gz_docs) -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) + $(MAKE) gz-doc + $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(RSYNC_DEST) clean-doc: $(RM_F) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) \ - $(mantxt) $(rsync_xdocs) \ + $(mantxt) \ NEWS NEWS.atom NEWS.html Documentation/standards.txt \ Documentation/flow.html Documentation/flow.html.gz \ Documentation/flow.txt.gz |