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-mda
  45 m1 += public-inbox-nntpd
  46 m1 += public-inbox-watch
  47 m1 += public-inbox-xcpdb
  48 m5 =
  49 m5 += public-inbox-config
  50 m5 += public-inbox-v1-format
  51 m5 += public-inbox-v2-format
  52 m7 =
  53 m7 += public-inbox-overview
  54 m8 =
  55 m8 += public-inbox-daemon
  56
  57 man1 := $(addsuffix .1, $(m1))
  58 man5 := $(addsuffix .5, $(m5))
  59 man7 := $(addsuffix .7, $(m7))
  60 man8 := $(addsuffix .8, $(m8))
  61
  62 all:: man html
  63
  64 manpages = $(man1) $(man5) $(man7) $(man8)
  65
  66 man: $(manpages)
  67
  68 prefix ?= $(PREFIX)
  69 prefix ?= $(HOME)
  70 mandir ?= $(prefix)/share/man
  71 man1dir = $(mandir)/man1
  72 man5dir = $(mandir)/man5
  73 man7dir = $(mandir)/man7
  74 man8dir = $(mandir)/man8
  75
  76 install-man: man
  77         $(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
  78         $(INSTALL) -d -m 755 $(DESTDIR)$(man5dir)
  79         $(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)
  80         $(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)
  81         $(INSTALL) -m 644 $(man1) $(DESTDIR)$(man1dir)
  82         $(INSTALL) -m 644 $(man5) $(DESTDIR)$(man5dir)
  83         $(INSTALL) -m 644 $(man7) $(DESTDIR)$(man7dir)
  84         $(INSTALL) -m 644 $(man8) $(DESTDIR)$(man8dir)
  85
  86 doc_install :: install-man
  87
  88 %.1 %.5 %.7 %.8 : Documentation/%.pod
  89         $(podman) -s $(subst .,,$(suffix $@)) $< $@+ && mv $@+ $@
  90
  91 check :: check-man
  92 check_man = @echo CHECK80 $<;COLUMNS=80 $(MAN) ./$^ | \
  93         $(AWK) '{gsub(/\b./,"")}length>80{print;err=1}END{exit(err)}' >&2
  94
  95 %.1.cols : %.1; $(check_man)
  96 %.5.cols : %.5; $(check_man)
  97 %.7.cols : %.7; $(check_man)
  98 %.8.cols : %.8; $(check_man)
  99
 100 check-man :: $(addsuffix .cols, $(manpages))
 101
 102 manuals :=
 103 manuals += $(m1)
 104 manuals += $(m5)
 105 manuals += $(m7)
 106 manuals += $(m8)
 107
 108 mantxt = $(addprefix Documentation/, $(addsuffix .txt, $(manuals)))
 109 docs += $(mantxt)
 110 dtxt += $(mantxt)
 111 docs += NEWS
 112
 113 all :: $(docs)
 114
 115 Documentation/%.txt : Documentation/%.pod
 116         $(podtext) $< $@+ && touch -r $< $@+ && mv $@+ $@
 117
 118 txt2pre = $(PERL) -I lib ./Documentation/txt2pre <$< >$@+ && \
 119         touch -r $< $@+ && mv $@+ $@
 120
 121 Documentation/standards.txt : Documentation/standards.perl
 122         $(PERL) $< >$@+ && touch -r $< $@+ && mv $@+ $@
 123
 124 RELEASES =
 125 RELEASES += v1.1.0-pre1
 126 RELEASES += v1.0.0
 127
 128 NEWS NEWS.atom NEWS.html :
 129         $(PERL) -I lib -w Documentation/mknews.perl $@ $(RELEASES)
 130
 131 # check for internal API changes:
 132 check :: NEWS check-NEWS.atom NEWS.html
 133
 134 check-NEWS.atom: NEWS.atom
 135         $(XMLSTARLET) val NEWS.atom || \
 136                 { e=$$?; test $$e -eq 0 || test $$e -eq 127; }
 137
 138 Documentation/%.html: Documentation/%.txt
 139         $(txt2pre)
 140
 141 %.html: %
 142         $(txt2pre)
 143
 144 docs_html := $(addsuffix .html, $(subst .txt,,$(dtxt)) $(txt)) NEWS.html
 145 html: $(docs_html)
 146 gz_docs := $(addsuffix .gz, $(docs) $(docs_html))
 147 rsync_docs := $(gz_docs) $(docs) $(docs_html) NEWS.atom NEWS.atom.gz
 148
 149 # external manpages which we host ourselves, since some packages
 150 # (currently just Xapian) doesn't host manpages themselves.
 151 xtxt :=
 152 xtxt += .copydatabase.1
 153 xtxt += .xapian-compact.1
 154 xtxt := $(addprefix Documentation/.x/, $(addsuffix .txt, $(xtxt)))
 155 xdocs := $(xtxt)
 156 xdocs_html := $(addsuffix .html, $(subst .txt,,$(xtxt)))
 157 gz_xdocs := $(addsuffix .gz, $(xdocs) $(xdocs_html))
 158 rsync_xdocs := $(gz_xdocs) $(xdocs_html) $(xdocs)
 159 xdoc: $(xdocs) $(xdocs_html)
 160
 161 Documentation/.x:
 162         mkdir -p $@
 163
 164 Documentation/.x/%.txt :: | Documentation/.x
 165         $(PERL) -w Documentation/extman.perl $@ >$@+
 166         mv $@+ $@
 167
 168 Documentation/.x/%.html: Documentation/.x/%.txt
 169         $(txt2pre)
 170
 171 doc: $(docs)
 172
 173 %.gz: %
 174         gzip -9 --rsyncable <$< >$@+
 175         touch -r $< $@+
 176         mv $@+ $@
 177
 178 gz-doc: $(gz_docs)
 179
 180 gz-xdoc: $(gz_xdocs)
 181
 182 rsync-doc: NEWS.atom.gz
 183         # /usr/share/doc/rsync/scripts/git-set-file-times{.gz} on Debian systems
 184         # It is also at: https://yhbt.net/git-set-file-times
 185         -git set-file-times $(docs) $(txt)
 186         $(MAKE) gz-doc gz-xdoc
 187         $(RSYNC) --chmod=Fugo=r -av $(rsync_docs) $(rsync_xdocs) $(RSYNC_DEST)
 188
 189 clean-doc:
 190         $(RM) $(man1) $(man5) $(man7) $(man8) $(gz_docs) $(docs_html) $(mantxt)
 191         $(RM) $(gz_xdocs) $(xdocs_html) $(xdocs)
 192         $(RM) NEWS NEWS.atom NEWS.html Documentation/standards.txt
 193
 194 clean :: clean-doc
 195
 196 pure_all ::
 197         @if test x"$(addprefix g, make)" != xgmake; then \
 198         echo W: gmake is currently required to build manpages; fi