Documentation/include.mk

   1 # Copyright (C) 2013-2021 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3 all::
   4
   5 RSYNC = rsync
   6 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
   7 AWK = awk
   8 MAN = man
   9 LEXGROG = lexgrog
  10
  11 # this is "xml" on FreeBSD and maybe some other distros:
  12 XMLSTARLET = xmlstarlet
  13
  14 # libgraph-easy-perl from Debian, Graph::Easy from CPAN
  15 GRAPH_EASY = graph-easy
  16
  17 # same as pod2text
  18 COLUMNS = 76
  19
  20 INSTALL = install
  21 PODMAN = pod2man
  22 PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
  23 PODMAN_OPTS += -r public-inbox.git
  24 podman = $(PODMAN) $(PODMAN_OPTS)
  25 PODTEXT = pod2text
  26 PODTEXT_OPTS = --stderr
  27 podtext = $(PODTEXT) $(PODTEXT_OPTS)
  28
  29 all:: man
  30
  31 manpages = $(man1) $(man5) $(man7) $(man8)
  32
  33 man: $(manpages)
  34
  35 prefix ?= $(PREFIX)
  36 prefix ?= $(HOME)
  37 mandir ?= $(INSTALLMAN1DIR)/..
  38 man5dir = $(mandir)/man5
  39 man7dir = $(mandir)/man7
  40 man8dir = $(mandir)/man8
  41
  42 install-man: man
  43         $(INSTALL) -d -m 755 $(DESTDIR)$(INSTALLMAN1DIR)
  44         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
  45         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
  46         $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
  47         $(INSTALL) -m 644 $(man1) $(DESTDIR)$(INSTALLMAN1DIR)
  48         $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
  49         $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
  50         $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
  51
  52 doc_install :: install-man
  53
  54 check :: check-man
  55 check_man = $(AWK) \
  56         '{gsub(/\b./,"")}$$0 !~ /\.onion/&&length>80{print;e=1}END{exit(e)}' \
  57         >&2
  58
  59 check-man :: $(check_80)
  60
  61 check-lexgrog :: $(check_lexgrog)
  62
  63 all :: $(docs)
  64
  65 txt2pre = $(PERL) -I lib ./Documentation/txt2pre >$@
  66
  67 Documentation/standards.txt : Documentation/standards.perl
  68         $(PERL) -w Documentation/standards.perl >$@+
  69         touch -r Documentation/standards.perl $@+
  70         mv $@+ $@
  71
  72 # flow.txt is checked into git since Graph::Easy isn't in many distros
  73 Documentation/flow.txt : Documentation/flow.ge
  74         (sed -ne '1,/^$$/p' <Documentation/flow.ge; \
  75                 $(GRAPH_EASY) Documentation/flow.ge || \
  76                         cat Documentation/flow.txt; \
  77                 echo; \
  78                 sed -ne '/^# Copyright/,$$p' <Documentation/flow.ge \
  79                 ) >$@+
  80         touch -r Documentation/flow.ge $@+
  81         mv $@+ $@
  82
  83 Documentation/lei-q.pod : lib/PublicInbox/Search.pm Documentation/common.perl
  84         $(PERL) -I lib -w Documentation/common.perl $@
  85
  86 NEWS NEWS.atom NEWS.html : $(news_deps)
  87         $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
  88
  89 # check for internal API changes:
  90 check :: NEWS .NEWS.atom.check NEWS.html
  91
  92 .NEWS.atom.check: NEWS.atom
  93         $(XMLSTARLET) val NEWS.atom || \
  94                 { e=$$?; test $$e -eq 0 || test $$e -eq 127; }
  95         >$@
  96
  97 html: $(docs_html)
  98
  99 doc: $(docs)
 100
 101 %.gz: %
 102         gzip -9 --rsyncable <$< >$@+
 103         touch -r $< $@+
 104         mv $@+ $@
 105
 106 gz-doc: $(gz_docs)
 107
 108 gz-xdoc: $(gz_xdocs)
 109
 110 rsync-doc: NEWS.atom.gz
 111         # /usr/share/doc/rsync/scripts/git-set-file-times{.gz} on Debian systems
 112         # It is also at: https://yhbt.net/git-set-file-times
 113         -git set-file-times $(docs) $(txt)
 114         $(MAKE) gz-doc gz-xdoc
 115         $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST)
 116
 117 clean-doc:
 118         $(RM_F) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) \
 119                 $(mantxt) $(rsync_xdocs) \
 120                 NEWS NEWS.atom NEWS.html Documentation/standards.txt \
 121                 Documentation/flow.html Documentation/flow.html.gz \
 122                 Documentation/flow.txt.gz
 123
 124 clean :: clean-doc
 125
 126 # No camel-cased tarballs or pathnames which MakeMaker creates,
 127 # this may not always be a Perl project.  This should match what
 128 # cgit generate, since git maintainers ensure git-archive has
 129 # stable tar output
 130 DIST_TREE = HEAD^{tree}
 131 DIST_VER =
 132 git-dist :
 133         ver=$$(git describe $(DIST_VER) | sed -ne s/v//p); \
 134         pkgpfx=public-inbox-$$ver; \
 135         git archive --prefix=$$pkgpfx/ --format=tar $(DIST_TREE) \
 136                 | gzip -n >$$pkgpfx.tar.gz; \
 137         echo $$pkgpfx.tar.gz created