Makefile

   1 include /usr/share/dpkg/pkg-info.mk
   2
   3 # overwriting below ensures that we can build without full PVE installed
   4 DGDIR=.
   5 ASCIIDOC_PVE=./asciidoc-pve
   6
   7 BUILDDIR ?= $(DEB_SOURCE)-$(DEB_VERSION)
   8 DSC=$(DEB_SOURCE)_$(DEB_VERSION).dsc
   9
  10 GEN_PACKAGE=pve-doc-generator
  11 DOC_PACKAGE=pve-docs
  12 MEDIAWIKI_PACKAGE=pve-docs-mediawiki
  13
  14 GITVERSION:=$(shell git rev-parse HEAD)
  15
  16 GEN_DEB=$(GEN_PACKAGE)_$(DEB_VERSION)_all.deb
  17 DOC_DEB=$(DOC_PACKAGE)_$(DEB_VERSION)_all.deb
  18 MEDIAWIKI_DEB=$(MEDIAWIKI_PACKAGE)_$(DEB_VERSION)_all.deb
  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         sed -i "s/@RELEASE@$$/$(DEB_VERSION_UPSTREAM)/" $@.tmp
  38         mv $@.tmp $@
  39
  40 -include ./pve-doc-generator.mk
  41
  42 GEN_DEB_SOURCES=                                \
  43         pve-doc-generator.mk                    \
  44         $(MANUAL_SOURCES)                       \
  45         pmxcfs.8-synopsis.adoc                  \
  46         qmeventd.8-synopsis.adoc                \
  47         docinfo.xml
  48
  49 GEN_SCRIPTS=                                    \
  50         gen-ha-groups-opts.pl                   \
  51         gen-ha-resources-opts.pl                \
  52         gen-datacenter.cfg.5-opts.pl            \
  53         gen-pct.conf.5-opts.pl                  \
  54         gen-pct-network-opts.pl                 \
  55         gen-pct-mountpoint-opts.pl              \
  56         gen-qm.conf.5-opts.pl                   \
  57         gen-cpu-models.conf.5-opts.pl           \
  58         gen-qm-cloud-init-opts.pl               \
  59         gen-vzdump.conf.5-opts.pl               \
  60         gen-pve-firewall-cluster-opts.pl        \
  61         gen-pve-firewall-host-opts.pl           \
  62         gen-pve-firewall-macros-adoc.pl         \
  63         gen-pve-firewall-rules-opts.pl          \
  64         gen-pve-firewall-vm-opts.pl             \
  65         gen-output-format-opts.pl
  66
  67 API_VIEWER_FILES=                                                       \
  68         api-viewer/apidata.js                                           \
  69         api-viewer/PVEAPI.js                                            \
  70         /usr/share/javascript/proxmox-widget-toolkit-dev/APIViewer.js
  71
  72 API_VIEWER_SOURCES=                             \
  73         api-viewer/index.html                   \
  74         api-viewer/apidoc.js
  75
  76 asciidoc-pve: asciidoc-pve.in link-refs.json
  77         cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
  78         sed -e s/@RELEASE@/$(DOCRELEASE)/ -i asciidoc-pve.tmp
  79         chmod +x asciidoc-pve.tmp
  80         mv asciidoc-pve.tmp asciidoc-pve
  81
  82 pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
  83         cat pve-docs-mediawiki-import.in link-refs.json >  pve-docs-mediawiki-import.tmp
  84         chmod +x pve-docs-mediawiki-import.tmp
  85         mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
  86
  87 INDEX_INCLUDES=                                                         \
  88         pve-admin-guide.pdf                                             \
  89         pve-admin-guide.epub                                            \
  90         chapter-index-table.adoc                                        \
  91         man1-index-table.adoc                                           \
  92         man5-index-table.adoc                                           \
  93         man8-index-table.adoc                                           \
  94         $(sort $(addsuffix .html, $(MANUAL_PAGES)) $(CHAPTER_LIST))
  95
  96 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
  97
  98 BROWSER?=xdg-open
  99
 100 README.html: README.adoc
 101         asciidoc -a toc $(ADOC_STDARG) -o $@ $<
 102
 103 .PHONY: index
 104 index: index.html
 105         test -z "$${PVE_DOC_INSTANTVIEW}" || $(BROWSER) index.html &
 106
 107 chapter-index-table.adoc: asciidoc-pve
 108         ./asciidoc-pve chapter-table >$@.tmp
 109         mv $@.tmp $@
 110
 111 man1-index-table.adoc: asciidoc-pve
 112         ./asciidoc-pve man1page-table >$@.tmp
 113         mv $@.tmp $@
 114
 115 man5-index-table.adoc: asciidoc-pve
 116         ./asciidoc-pve man5page-table >$@.tmp
 117         mv $@.tmp $@
 118
 119 man8-index-table.adoc: asciidoc-pve
 120         ./asciidoc-pve man8page-table >$@.tmp
 121         mv $@.tmp $@
 122
 123 index.html: index.adoc $(API_VIEWER_SOURCES) $(INDEX_INCLUDES)
 124         asciidoc $(ADOC_STDARG) -o $@ index.adoc
 125
 126 pve-admin-guide.html: $(PVE_ADMIN_GUIDE_ADOCDEPENDS)
 127         asciidoc -a pvelogo $(ADOC_STDARG) -o $@ pve-admin-guide.adoc
 128
 129 pve-admin-guide.chunked: $(PVE_ADMIN_GUIDE_ADOCDEPENDS)
 130         rm -rf $@.tmp $@
 131         mkdir $@.tmp
 132         a2x -D $@.tmp -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
 133         mv $@.tmp/$@ $@
 134
 135 PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
 136 PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
 137
 138 YEAR:=$(shell date '+%Y')
 139 pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
 140         sed -e 's/@RELEASE@/$(DOCRELEASE)/' -e 's/@YEAR@/$(YEAR)/' <$< >$@
 141
 142 pve-admin-guide.pdf: $(PVE_ADMIN_GUIDE_ADOCDEPENDS) docinfo.xml pve-admin-guide-docinfo.xml
 143         rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
 144         rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
 145         grep ">Release $(DOCRELEASE)<" pve-admin-guide-docinfo.xml || (echo "wrong release in  pve-admin-guide-docinfo.xml" && false);
 146         a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="$(PVE_DOCBOOK_CONF)" --dblatex-opts $(PVE_DBLATEX_OPTS) pve-admin-guide.adoc
 147         rm proxmox-logo.pdf proxmox-ci-header.pdf
 148
 149 pve-admin-guide.epub: $(PVE_ADMIN_GUIDE_ADOCDEPENDS)
 150         rm -rf $@.tmp $@
 151         mkdir $@.tmp
 152         a2x -D $@.tmp -f epub --asciidoc-opts="$(PVE_DOCBOOK_CONF)" pve-admin-guide.adoc
 153         mv $@.tmp/$@ $@
 154
 155 api-viewer/apidata.js: extractapi.pl
 156         ./extractapi.pl >$@
 157
 158 api-viewer/apidoc.js: $(API_VIEWER_FILES)
 159         cat $(API_VIEWER_FILES) >$@.tmp
 160         mv $@.tmp $@
 161
 162 $(BUILDDIR):
 163         rm -rf $@ $@.tmp
 164         rsync -a * $@.tmp/
 165         echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout $(GITVERSION)" > $@.tmp/debian/SOURCE
 166         mv $@.tmp $@
 167
 168 .PHONY: dsc deb
 169 dsc: $(DSC)
 170 $(DSC): $(BUILDDIR)
 171         cd $(BUILDDIR); dpkg-buildpackage -S -us -uc -d
 172         lintian $(DSC)
 173
 174 sbuild: $(DSC)
 175         sbuild $(DSC)
 176
 177 deb:
 178         rm -f $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB)
 179         rm -rf $(BUILDDIR)
 180         $(MAKE) $(DOC_DEB)
 181
 182 $(MEDIAWIKI_DEB) $(GEN_DEB): $(DOC_DEB)
 183 $(DOC_DEB): $(BUILDDIR)
 184         cd $(BUILDDIR); dpkg-buildpackage -b -us -uc
 185         lintian $(DOC_DEB) $(GEN_DEB) $(MEDIAWIKI_DEB)
 186
 187 .PHONY: dinstall
 188 dinstall: $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB)
 189         dpkg -i $(GEN_DEB) $(DOC_DEB) # $(MEDIAWIKI_DEB)
 190
 191 .PHONY: clean-build
 192 clean-build:
 193         rm -rf build
 194
 195 .PHONY: install
 196 install: gen-install doc-install mediawiki-install
 197
 198 .PHONY: gen-install
 199 gen-install: $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
 200         install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)
 201         install -dm755 $(DESTDIR)/usr/share/doc/$(GEN_PACKAGE)
 202         install -dm755 $(DESTDIR)/usr/bin
 203         # install files
 204         install -m 0644 $(GEN_DEB_SOURCES) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
 205         install -m 0755 $(GEN_SCRIPTS) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
 206         # install asciidoc-pve
 207         install -m 0755 asciidoc-pve $(DESTDIR)/usr/bin/
 208         install -D -m 0644 asciidoc/mediawiki.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/mediawiki.conf
 209         install -m 0644 asciidoc/asciidoc-pve.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
 210         install -m 0644 asciidoc/pve-html.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
 211
 212 .PHONY: doc-install
 213 doc-install: index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images examples
 214         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
 215         install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
 216         # install files for pvedocs package
 217         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
 218         install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
 219         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/examples/
 220         install -m 755 examples/guest-example-hookscript.pl $(DESTDIR)/usr/share/$(DOC_PACKAGE)/examples/
 221         install -m 0644 index.html $(INDEX_INCLUDES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)
 222         install -m 0644 $(WIKI_IMPORTS) $(DESTDIR)/usr/share/$(DOC_PACKAGE)
 223         # install images
 224         make -C images install
 225         # install screenshot images
 226         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/screenshot
 227         install -m 0644 images/screenshot/*.png $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/screenshot
 228         # install api doc viewer
 229         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
 230         install -m 0644 $(API_VIEWER_SOURCES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
 231
 232 .PHONY: mediawiki-install
 233 mediawiki-install: pve-docs-mediawiki-import
 234         install -dm755 $(DESTDIR)/usr/share/$(MEDIAWIKI_PACKAGE)
 235         install -dm755 $(DESTDIR)/usr/share/doc/$(MEDIAWIKI_PACKAGE)
 236         install -dm755 $(DESTDIR)/usr/bin
 237         install -dm755 $(DESTDIR)/usr/share/$(MEDIAWIKI_PACKAGE)
 238         install -dm755 $(DESTDIR)/usr/share/doc/$(MEDIAWIKI_PACKAGE)
 239         install -m 0755 pve-docs-mediawiki-import $(DESTDIR)/usr/bin/
 240
 241 .PHONY: upload
 242 upload: $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB)
 243         tar cf - $(GEN_DEB) $(DOC_DEB) $(MEDIAWIKI_DEB) | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist bullseye
 244
 245 .PHONY: update
 246 update:
 247         make clean clean-static
 248         make update-static
 249         make all
 250
 251 .PHONY: update-static
 252 update-static:
 253         make clean-static
 254         make $(filter %-synopsis.adoc %-opts.adoc, $(PVE_ADMIN_GUIDE_ADOCDEPENDS)) pve-firewall-macros.adoc api-viewer/apidata.js
 255
 256 .PHONY: clean-static
 257 clean-static:
 258         find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -not -name qmeventd.8-synopsis.adoc -exec rm -f \{\} \;
 259         rm -f api-viewer/apidata.js
 260         rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
 261
 262 clean:
 263         rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
 264         rm -f *.deb *.dsc *.tar.* *.changes *.buildinfo *.build
 265         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
 266         rm -rf .pve-doc-depends
 267         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
 268         rm -rf $(DEB_SOURCE)-[0-9]*/