X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Finclude.mk;h=bfbc495f0470cff4e88131f596e494f7335d21c6;hb=7249c2ac6493849739ea7c1ad5265cff421e2869;hp=0229bf40030b25ac246a798ebcd1af500cd1503b;hpb=6cd459ceeaa024639e4f905b871971c9c0794326;p=public-inbox.git diff --git a/Documentation/include.mk b/Documentation/include.mk index 0229bf40..bfbc495f 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -1,4 +1,4 @@ -# Copyright (C) 2013-2019 all contributors +# Copyright (C) 2013-2021 all contributors # License: AGPL-3.0+ all:: @@ -6,21 +6,21 @@ 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 -# same as pod2text -COLUMNS = 76 +# libgraph-easy-perl from Debian, Graph::Easy from CPAN +GRAPH_EASY = graph-easy 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 @@ -48,11 +48,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_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) txt2pre = $(PERL) -I lib ./Documentation/txt2pre >$@ @@ -62,12 +65,21 @@ Documentation/standards.txt : 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: @@ -80,9 +92,6 @@ check :: NEWS .NEWS.atom.check NEWS.html html: $(docs_html) -Documentation/.x: - mkdir -p $@ - doc: $(docs) %.gz: % @@ -92,19 +101,19 @@ 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) \ - NEWS NEWS.atom NEWS.html Documentation/standards.txt + $(mantxt) \ + NEWS NEWS.atom NEWS.html Documentation/standards.txt \ + Documentation/flow.html Documentation/flow.html.gz \ + Documentation/flow.txt.gz clean :: clean-doc