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