Makefile

   1 DGDIR=.
   2 ASCIIDOC_PVE=./asciidoc-pve
   3
   4 GEN_PACKAGE=pve-doc-generator
   5 DOC_PACKAGE=pve-docs
   6 MEDIAWIKI_PACKAGE=pve-docs-mediawiki
   7
   8 # also update debian/changelog
   9 PKGREL=16
  10
  11 GITVERSION:=$(shell git rev-parse HEAD)
  12
  13 ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
  14
  15 GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
  16 DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
  17 MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
  18 DOC_BUILDDEPS := asciidoc-dblatex, source-highlight, librsvg2-bin
  19
  20 export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
  21 SOURCE_DATE_HUMAN := $(shell date -d "@${SOURCE_DATE_EPOCH}")
  22
  23 all: index.html
  24
  25 .PHONY: verify-images
  26 verify-images:
  27         for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
  28
  29 ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
  30 .pve-doc-depends link-refs.json: ${ADOC_SOURCES_GUESS} scan-adoc-refs
  31         ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp
  32         @cmp --quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends
  33         @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
  34
  35 pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in
  36         cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp
  37         mv $@.tmp $@
  38
  39 include ./pve-doc-generator.mk
  40
  41 GEN_DEB_SOURCES=                                \
  42         pve-doc-generator.mk                    \
  43         ${MANUAL_SOURCES}                       \
  44         pmxcfs.8-synopsis.adoc                  \
  45         docinfo.xml
  46
  47 GEN_SCRIPTS=                                    \
  48         gen-ha-groups-opts.pl                   \
  49         gen-ha-resources-opts.pl                \
  50         gen-datacenter.cfg.5-opts.pl            \
  51         gen-pct.conf.5-opts.pl                  \
  52         gen-pct-network-opts.pl                 \
  53         gen-pct-mountpoint-opts.pl              \
  54         gen-qm.conf.5-opts.pl                   \
  55         gen-vzdump.conf.5-opts.pl               \
  56         gen-pve-firewall-cluster-opts.pl        \
  57         gen-pve-firewall-host-opts.pl           \
  58         gen-pve-firewall-macros-adoc.pl         \
  59         gen-pve-firewall-rules-opts.pl          \
  60         gen-pve-firewall-vm-opts.pl
  61
  62 API_VIEWER_SOURCES=                             \
  63         api-viewer/index.html                   \
  64         api-viewer/apidoc.js
  65
  66 asciidoc-pve: asciidoc-pve.in link-refs.json
  67         cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
  68         sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
  69         chmod +x asciidoc-pve.tmp
  70         mv asciidoc-pve.tmp asciidoc-pve
  71
  72 pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
  73         cat pve-docs-mediawiki-import.in link-refs.json >  pve-docs-mediawiki-import.tmp
  74         chmod +x pve-docs-mediawiki-import.tmp
  75         mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
  76
  77 INDEX_INCLUDES=                                                         \
  78         pve-admin-guide.pdf                                             \
  79         pve-admin-guide.epub                                            \
  80         chapter-index-table.adoc                                        \
  81         man1-index-table.adoc                                           \
  82         man5-index-table.adoc                                           \
  83         man8-index-table.adoc                                           \
  84         $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
  85
  86 ADOC_STDARG=-b $(shell pwd)/asciidoc/pve-html -f asciidoc/asciidoc-pve.conf -a icons -a data-uri -a "date=${SOURCE_DATE_HUMAN}" -a "revnumber=${DOCRELEASE}" -a footer-style=revdate
  87
  88 BROWSER?=xdg-open
  89
  90
  91 %-nwdiag.svg: %.nwdiag
  92         nwdiag -T svg $*.nwdiag -o $@;
  93
  94 README.html: README.adoc
  95         asciidoc -a toc ${ADOC_STDARG} -o $@ $<
  96
  97 .PHONY: index
  98 index: index.html
  99         $(BROWSER) index.html &
 100
 101 chapter-index-table.adoc: asciidoc-pve
 102         ./asciidoc-pve chapter-table >$@.tmp
 103         mv $@.tmp $@
 104
 105 man1-index-table.adoc: asciidoc-pve
 106         ./asciidoc-pve man1page-table >$@.tmp
 107         mv $@.tmp $@
 108
 109 man5-index-table.adoc: asciidoc-pve
 110         ./asciidoc-pve man5page-table >$@.tmp
 111         mv $@.tmp $@
 112
 113 man8-index-table.adoc: asciidoc-pve
 114         ./asciidoc-pve man8page-table >$@.tmp
 115         mv $@.tmp $@
 116
 117 index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
 118         asciidoc ${ADOC_STDARG} -o $@ index.adoc
 119
 120 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
 121         asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
 122
 123 pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
 124         rm -rf pve-admin-guide.chunked
 125         a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
 126
 127 PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
 128 PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
 129
 130 pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
 131         sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
 132
 133 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
 134         rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
 135         rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
 136         grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in  pve-admin-guide-docinfo.xml" && false);
 137         a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc
 138         rm proxmox-logo.pdf proxmox-ci-header.pdf
 139
 140 pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
 141         a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
 142
 143 api-viewer/apidata.js: extractapi.pl
 144         ./extractapi.pl >$@
 145
 146 api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
 147         cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
 148
 149 .PHONY: dinstall
 150 dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 151         dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 152
 153 .PHONY: deb
 154 deb:
 155         rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 156         make all-debs
 157
 158 .PHONY: all-debs
 159 all-debs: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 160
 161 .PHONY: clean-build
 162 clean-build:
 163         rm -rf build
 164
 165 define prepare_build
 166         rm -rf build-$1
 167         mkdir build-$1
 168         cp -a debian build-$1/debian
 169         mv build-$1/debian/control.in build-$1/debian/control
 170         echo >> build-$1/debian/control
 171         cat debian/$1.control >> build-$1/debian/control
 172         echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build-$1/debian/SOURCE
 173         install -dm755 build-$1/usr/share/$1
 174         install -dm755 build-$1/usr/share/doc/$1
 175 endef
 176
 177 .PHONY: gen-deb
 178 gen-deb: $(GEN_DEB)
 179 $(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
 180         $(call prepare_build,$(GEN_PACKAGE))
 181         install -dm755 build-$(GEN_PACKAGE)/usr/bin
 182         # install files
 183         install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
 184         install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
 185         # install asciidoc-pve
 186         install -m 0755 asciidoc-pve build-$(GEN_PACKAGE)/usr/bin/
 187         install -D -m 0644 asciidoc/mediawiki.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf
 188         install -m 0644 asciidoc/asciidoc-pve.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
 189         install -m 0644 asciidoc/pve-html.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
 190         cd build-$(GEN_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
 191         lintian ${GEN_DEB}
 192
 193 .PHONY: doc-deb
 194 doc-deb: $(DOC_DEB)
 195 $(DOC_DEB): index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images
 196         $(call prepare_build,$(DOC_PACKAGE))
 197         sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
 198         # install files for pvedocs package
 199         install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
 200         install -dm755 build-$(DOC_PACKAGE)/usr/share/doc/${DOC_PACKAGE}
 201         install -m 0644 index.html ${INDEX_INCLUDES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
 202         install -m 0644 ${WIKI_IMPORTS} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
 203         # install screenshot images
 204         install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
 205         install -m 0644 images/screenshot/*.png build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
 206         # install api doc viewer
 207         install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
 208         install -m 0644 ${API_VIEWER_SOURCES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
 209         cd build-$(DOC_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
 210         lintian ${DOC_DEB}
 211
 212 .PHONY: mediawiki-deb
 213 mediawiki-deb: $(MEDIAWIKI_DEB)
 214 $(MEDIAWIKI_DEB): pve-docs-mediawiki-import
 215         $(call prepare_build,$(MEDIAWIKI_PACKAGE))
 216         cp pve-docs-mediawiki-import build-$(MEDIAWIKI_PACKAGE)/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import
 217         cd build-$(MEDIAWIKI_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
 218         lintian ${MEDIAWIKI_DEB}
 219
 220 .PHONY: upload
 221 upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 222         tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist stretch
 223
 224 .PHONY: update
 225 update: clean clean-static | update-static
 226         make all
 227
 228 .PHONY: update-static
 229 update-static: clean-static | $(filter %-synopsis.adoc %-opts.adoc, ${PVE_ADMIN_GUIDE_ADOCDEPENDS}) pve-firewall-macros.adoc api-viewer/apidata.js
 230
 231 .PHONY: clean-static
 232 clean-static:
 233         find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
 234         rm -f api-viewer/apidata.js
 235         rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
 236
 237 clean:
 238         rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
 239         rm -f *.deb *.changes *.buildinfo
 240         rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import
 241         rm -rf .pve-doc-depends
 242         rm -f pve-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pve-admin-guide-docinfo.xml
 243         rm -rf build-*