Documentation/include.mk

   1 # Copyright (C) 2013-2019 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3 all::
   4
   5 # Note: some GNU-isms present and required to build docs
   6 # (including manpages), but at least this should not trigger
   7 # warnings with BSD make(1) when running "make check"
   8 # Maybe it's not worth it to support non-GNU make, though...
   9 RSYNC = rsync
  10 RSYNC_DEST = public-inbox.org:/srv/public-inbox/
  11 AWK = awk
  12 MAN = man
  13
  14 # this is "xml" on FreeBSD and maybe some other distros:
  15 XMLSTARLET = xmlstarlet
  16
  17 # same as pod2text
  18 COLUMNS = 76
  19
  20 txt := INSTALL README COPYING TODO HACKING
  21 dtxt := design_notes.txt design_www.txt dc-dlvr-spam-flow.txt hosted.txt
  22 dtxt += marketing.txt
  23 dtxt += standards.txt
  24 dtxt := $(addprefix Documentation/, $(dtxt))
  25 docs := $(txt) $(dtxt)
  26
  27 INSTALL = install
  28 PODMAN = pod2man
  29 PODMAN_OPTS = -v --stderr -d 1993-10-02 -c 'public-inbox user manual'
  30 PODMAN_OPTS += -r public-inbox.git
  31 podman = $(PODMAN) $(PODMAN_OPTS)
  32 PODTEXT = pod2text
  33 PODTEXT_OPTS = --stderr
  34 podtext = $(PODTEXT) $(PODTEXT_OPTS)
  35
  36 # MakeMaker only seems to support manpage sections 1 and 3...
  37 m1 =
  38 m1 += public-inbox-compact
  39 m1 += public-inbox-convert
  40 m1 += public-inbox-edit
  41 m1 += public-inbox-httpd
  42 m1 += public-inbox-index
  43 m1 += public-inbox-init
  44 m1 += public-inbox-learn
  45 m1 += public-inbox-mda
  46 m1 += public-inbox-nntpd
  47 m1 += public-inbox-watch
  48 m1 += public-inbox-xcpdb
  49 m5 =
  50 m5 += public-inbox-config
  51 m5 += public-inbox-v1-format
  52 m5 += public-inbox-v2-format
  53 m7 =
  54 m7 += public-inbox-overview
  55 m8 =
  56 m8 += public-inbox-daemon
  57
  58 man1 := $(addsuffix .1, $(m1))
  59 man5 := $(addsuffix .5, $(m5))
  60 man7 := $(addsuffix .7, $(m7))
  61 man8 := $(addsuffix .8, $(m8))
  62
  63 all:: man html
  64
  65 manpages = $(man1) $(man5) $(man7) $(man8)
  66
  67 man: $(manpages)
  68
  69 prefix ?= $(PREFIX)
  70 prefix ?= $(HOME)
  71 mandir ?= $(prefix)/share/man
  72 man1dir = $(mandir)/man1
  73 man5dir = $(mandir)/man5
  74 man7dir = $(mandir)/man7
  75 man8dir = $(mandir)/man8
  76
  77 install-man: man
  78         $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
  79         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
  80         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
  81         $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
  82         $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
  83         $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
  84         $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
  85         $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
  86
  87 doc_install :: install-man
  88
  89 %.1 %.5 %.7 %.8 : Documentation/%.pod
  90         $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
  91
  92 check :: check-man
  93 check_man = @echo CHECK80 $<;COLUMNS=80 $(MAN) ./$^ | \
  94         $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}' >&2
  95
  96 %.1.cols : %.1; $(check_man)
  97 %.5.cols : %.5; $(check_man)
  98 %.7.cols : %.7; $(check_man)
  99 %.8.cols : %.8; $(check_man)
 100
 101 check-man :: $(addsuffix .cols, $(manpages))
 102
 103 manuals :=
 104 manuals += $(m1)
 105 manuals += $(m5)
 106 manuals += $(m7)
 107 manuals += $(m8)
 108
 109 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
 110 docs += $(mantxt)
 111 dtxt += $(mantxt)
 112 docs += NEWS
 113
 114 all :: $(docs)
 115
 116 Documentation/%.txt : Documentation/%.pod
 117         $(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@
 118
 119 txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
 120         touch -r $< $@+ && mv $@+ $@
 121
 122 Documentation/standards.txt : Documentation/standards.perl
 123         $(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@
 124
 125 RELEASES =
 126 RELEASES += v1.1.0-pre1
 127 RELEASES += v1.0.0
 128
 129 NEWS NEWS.atom NEWS.html :
 130         $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
 131
 132 # check for internal API changes:
 133 check :: NEWS check-NEWS.atom NEWS.html
 134
 135 check-NEWS.atom: NEWS.atom
 136         $(XMLSTARLET) val NEWS.atom || \
 137                 { e=$$?; test $$e -eq 0 || test $$e -eq 127; }
 138
 139 Documentation/%.html: Documentation/%.txt
 140         $(txt2pre)
 141
 142 %.html: %
 143         $(txt2pre)
 144
 145 docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt)) NEWS.html
 146 html: $(docs_html)
 147 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
 148 rsync_docs := $(gz_docs) $(docs) $(docs_html) NEWS.atom NEWS.atom.gz
 149
 150 # external manpages which we host ourselves, since some packages
 151 # (currently just Xapian) doesn't host manpages themselves.
 152 xtxt :=
 153 xtxt += .copydatabase.1
 154 xtxt += .xapian-compact.1
 155 xtxt := $(addprefix Documentation/.x/, $(addsuffix .txt, $(xtxt)))
 156 xdocs := $(xtxt)
 157 xdocs_html := $(addsuffix .html, $(subst .txt,,$(xtxt)))
 158 gz_xdocs := $(addsuffix .gz, $(xdocs) $(xdocs_html))
 159 rsync_xdocs := $(gz_xdocs) $(xdocs_html) $(xdocs)
 160 xdoc: $(xdocs) $(xdocs_html)
 161
 162 Documentation/.x:
 163         mkdir -p $@
 164
 165 Documentation/.x/%.txt :: | Documentation/.x
 166         $(PERL) -w Documentation/extman.perl $@ >$@+
 167         mv $@+ $@
 168
 169 Documentation/.x/%.html: Documentation/.x/%.txt
 170         $(txt2pre)
 171
 172 doc: $(docs)
 173
 174 %.gz: %
 175         gzip -9 --rsyncable <$< >$@+
 176         touch -r $< $@+
 177         mv $@+ $@
 178
 179 gz-doc: $(gz_docs)
 180
 181 gz-xdoc: $(gz_xdocs)
 182
 183 rsync-doc: NEWS.atom.gz
 184         # /usr/share/doc/rsync/scripts/git-set-file-times{.gz} on Debian systems
 185         # It is also at: https://yhbt.net/git-set-file-times
 186         -git set-file-times $(docs) $(txt)
 187         $(MAKE) gz-doc gz-xdoc
 188         $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST)
 189
 190 clean-doc:
 191         $(RM) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) $(mantxt)
 192         $(RM) $(gz_xdocs) $(xdocs_html) $(xdocs)
 193         $(RM) NEWS NEWS.atom NEWS.html Documentation/standards.txt
 194
 195 clean :: clean-doc
 196
 197 pure_all ::
 198         @if test x"$(addprefix g, make)" != xgmake; then \
 199         echo W: gmake is currently required to build manpages; fi