doc: lei-q: document SEARCH TERMS prefixes

[public-inbox.git] / Documentation / include.mk

diff --git a/Documentation/include.mk b/Documentation/include.mk
index 3d88fcec29bd85e0eb8cb9ef663e2edff9aa7db2..149f9e3ce42e4a40ce66426d187ae7321c606079 100644 (file)
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -1,4 +1,4 @@
-# Copyright (C) 2013-2019 all contributors <meta@public-inbox.org>
+# Copyright (C) 2013-2021 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 all::
 
@@ -6,10 +6,14 @@ 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
 
@@ -48,11 +52,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,6 +69,20 @@ Documentation/standards.txt : 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' <Documentation/flow.ge; \
+               $(GRAPH_EASY) Documentation/flow.ge || \
+                       cat Documentation/flow.txt; \
+               echo; \
+               sed -ne '/^# Copyright/,$$p' <Documentation/flow.ge \
+               ) >$@+
+       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 : $(news_deps)
        $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
 
@@ -75,9 +96,6 @@ check :: NEWS .NEWS.atom.check NEWS.html
 
 html: $(docs_html)
 
-Documentation/.x:
-       mkdir -p $@
-
 doc: $(docs)
 
 %.gz: %
@@ -99,7 +117,9 @@ rsync-doc: NEWS.atom.gz
 clean-doc:
        $(RM_F) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) \
                $(mantxt) $(rsync_xdocs) \
-               NEWS NEWS.atom NEWS.html Documentation/standards.txt
+               NEWS NEWS.atom NEWS.html Documentation/standards.txt \
+               Documentation/flow.html Documentation/flow.html.gz \
+               Documentation/flow.txt.gz
 
 clean :: clean-doc