Makefile

   1 DGDIR=.
   2 ASCIIDOC_PMG=./asciidoc-pmg
   3
   4 GEN_PACKAGE=pmg-doc-generator
   5 DOC_PACKAGE=pmg-docs
   6
   7 # also update debian/changelog
   8 PKGREL=8
   9
  10 ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
  11
  12 GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
  13 DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
  14 DOC_BUILDDEPS := dblatex, source-highlight, inkscape, imagemagick
  15
  16
  17 all: index.html
  18
  19 .PHONY: verify-images
  20 verify-images: png-verify.pl
  21         for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
  22
  23 ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
  24 .pmg-doc-depends link-refs.json: ${ADOC_SOURCES_GUESS} scan-adoc-refs
  25         ./scan-adoc-refs *.adoc --depends .pmg-doc-depends.tmp > link-refs.json.tmp
  26         @cmp --quiet .pmg-doc-depends .pmg-doc-depends.tmp || mv .pmg-doc-depends.tmp .pmg-doc-depends
  27         @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
  28
  29 pmg-doc-generator.mk: .pmg-doc-depends pmg-doc-generator.mk.in
  30         cat pmg-doc-generator.mk.in .pmg-doc-depends > $@.tmp
  31         mv $@.tmp $@
  32
  33 include ./pmg-doc-generator.mk
  34
  35 GEN_DEB_SOURCES=                                \
  36         pmg-doc-generator.mk                    \
  37         ${MANUAL_SOURCES}                       \
  38         docinfo.xml
  39
  40 GEN_SCRIPTS=                                    \
  41         gen-cluster.conf.5-opts.pl              \
  42         gen-fetchmail.conf.5-opts.pl            \
  43         gen-ldap.conf.5-opts.pl                 \
  44         gen-pmg.conf.5-opts.pl                  \
  45         gen-user.conf.5-opts.pl
  46
  47 API_VIEWER_SOURCES=                             \
  48         api-viewer/index.html                   \
  49         api-viewer/apidoc.js
  50
  51 asciidoc-pmg: asciidoc-pmg.in link-refs.json
  52         cat asciidoc-pmg.in link-refs.json >asciidoc-pmg.tmp
  53         sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pmg.tmp
  54         chmod +x asciidoc-pmg.tmp
  55         mv asciidoc-pmg.tmp asciidoc-pmg
  56
  57 INDEX_INCLUDES=                                                         \
  58         pmg-admin-guide.pdf                                             \
  59         pmg-admin-guide.epub                                            \
  60         chapter-index-table.adoc                                        \
  61         man1-index-table.adoc                                           \
  62         man5-index-table.adoc                                           \
  63         man8-index-table.adoc                                           \
  64         $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
  65
  66 ADOC_STDARG=-b $(shell pwd)/asciidoc/pmg-html -f asciidoc/asciidoc-pmg.conf -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
  67
  68 BROWSER?=xdg-open
  69
  70
  71 README.html: README.adoc
  72         asciidoc -a toc ${ADOC_STDARG} -o $@ $<
  73
  74 .PHONY: index
  75 index: index.html
  76         $(BROWSER) index.html &
  77
  78 chapter-index-table.adoc: asciidoc-pmg
  79         ./asciidoc-pmg chapter-table >$@.tmp
  80         mv $@.tmp $@
  81
  82 man1-index-table.adoc: asciidoc-pmg
  83         ./asciidoc-pmg man1page-table >$@.tmp
  84         mv $@.tmp $@
  85
  86 man5-index-table.adoc: asciidoc-pmg
  87         ./asciidoc-pmg man5page-table >$@.tmp
  88         mv $@.tmp $@
  89
  90 man8-index-table.adoc: asciidoc-pmg
  91         ./asciidoc-pmg man8page-table >$@.tmp
  92         mv $@.tmp $@
  93
  94 index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
  95         asciidoc ${ADOC_STDARG} -o $@ index.adoc
  96
  97 pmg-admin-guide.html: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
  98         asciidoc -a pmglogo ${ADOC_STDARG} -o $@ pmg-admin-guide.adoc
  99
 100 pmg-admin-guide.chunked: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
 101         rm -rf pmg-admin-guide.chunked
 102         a2x -a docinfo -a docinfo1 -a icons -f chunked pmg-admin-guide.adoc
 103
 104 PMG_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pmg-docbook -f asciidoc/asciidoc-pmg.conf
 105
 106 pmg-admin-guide-docinfo.xml: pmg-admin-guide-docinfo.xml.in
 107         sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
 108
 109 pmg-admin-guide.pdf: ${PMG_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pmg-admin-guide-docinfo.xml
 110         inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
 111         inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
 112         grep ">Release ${DOCRELEASE}<" pmg-admin-guide-docinfo.xml || (echo "wrong release in  pmg-admin-guide-docinfo.xml" && false);
 113         a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PMG_DOCBOOK_CONF}" --dblatex-opts "-p ./asciidoc/pmg-dblatex.xsl -s asciidoc/dblatex-custom.sty" pmg-admin-guide.adoc
 114         rm proxmox-logo.pdf proxmox-ci-header.pdf
 115
 116 pmg-admin-guide.epub: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
 117         a2x -f epub --asciidoc-opts="${PMG_DOCBOOK_CONF}" pmg-admin-guide.adoc
 118
 119 api-viewer/apidata.js: extractapi.pl
 120         ./extractapi.pl >$@
 121
 122 api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PMGAPI.js
 123         cat api-viewer/apidata.js api-viewer/PMGAPI.js >$@
 124
 125 .PHONY: dinstall
 126 dinstall: ${GEN_DEB} ${DOC_DEB}
 127         dpkg -i ${GEN_DEB} ${DOC_DEB}
 128
 129 .PHONY: deb
 130 deb:
 131         rm -f ${GEN_DEB} ${DOC_DEB}
 132         make all-debs
 133
 134 .PHONY: all-debs
 135 all-debs: ${GEN_DEB} ${DOC_DEB}
 136
 137 .PHONY: clean-build
 138 clean-build:
 139         rm -rf build
 140
 141 define prepare_build
 142         rm -rf build-$1
 143         mkdir build-$1
 144         cp -a debian build-$1/debian
 145         mv build-$1/debian/control.in build-$1/debian/control
 146         echo >> build-$1/debian/control
 147         cat debian/$1.control >> build-$1/debian/control
 148         install -dm755 build-$1/usr/share/$1
 149         install -dm755 build-$1/usr/share/doc/$1
 150 endef
 151
 152 .PHONY: gen-deb
 153 gen-deb: $(GEN_DEB)
 154 $(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pmg
 155         $(call prepare_build,$(GEN_PACKAGE))
 156         install -dm755 build-$(GEN_PACKAGE)/usr/bin
 157         # install files
 158         install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
 159         install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
 160         # install asciidoc-pmg
 161         install -m 0755 asciidoc-pmg build-$(GEN_PACKAGE)/usr/bin/
 162         install -dm755 build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
 163         install -m 0644 asciidoc/asciidoc-pmg.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
 164         install -m 0644 asciidoc/pmg-html.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
 165         cd build-$(GEN_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
 166         lintian ${GEN_DEB}
 167
 168 .PHONY: doc-deb
 169 doc-deb: $(DOC_DEB)
 170 $(DOC_DEB): index.html $(API_VIEWER_SOURCES) verify-images
 171         $(call prepare_build,$(DOC_PACKAGE))
 172         sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
 173         # install files for pmgdocs package
 174         install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
 175         install -dm755 build-$(DOC_PACKAGE)/usr/share/doc/${DOC_PACKAGE}
 176         install -m 0644 index.html ${INDEX_INCLUDES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
 177         # install screenshot images
 178         install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
 179         install -m 0644 images/screenshot/*.png build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
 180         # install api doc viewer
 181         install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
 182         install -m 0644 ${API_VIEWER_SOURCES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
 183         cd build-$(DOC_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
 184         lintian ${DOC_DEB}
 185
 186 .PHONY: upload
 187 upload: ${GEN_DEB} ${DOC_DEB}
 188         tar cf - ${GEN_DEB} ${DOC_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pmg --dist stretch
 189
 190 .PHONY: update
 191 update: clean
 192         find . -regex '.*-\(opts\|synopsis\)\.adoc' -exec rm -f \{\} \;
 193         rm -f api-viewer/apidata.js
 194         make all
 195
 196 clean:
 197         find . -name '*~' -exec rm {} ';'
 198         rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
 199         rm -f *.deb *.changes *.buildinfo
 200         rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pmg-admin-guide.chunked asciidoc-pmg link-refs.json .asciidoc-pmg-tmp_* pmg-smtp-filter.8-synopsis.adoc pmgpolicy.8-synopsis.adoc pmgsh.1-synopsis.adoc
 201         rm -rf .pmg-doc-depends
 202         rm -f pmg-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pmg-admin-guide-docinfo.xml
 203         rm -rf build-*