remove note about vlan management interface
[pve-docs.git] / Makefile
CommitLineData
bef0c1b4 1DGDIR=.
c38115e9 2ASCIIDOC_PVE=./asciidoc-pve
bef0c1b4 3
9015f48f
DM
4GEN_PACKAGE=pve-doc-generator
5DOC_PACKAGE=pve-docs
cfabc2e9 6MEDIAWIKI_PACKAGE=pve-docs-mediawiki
9344ee0d
DM
7
8# also update debian/changelog
e2a74c9e 9PKGREL=8
9344ee0d 10
60955877 11GITVERSION:=$(shell git rev-parse HEAD)
b4f3c18a 12
0a3c58e0
TL
13ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
14
15GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
ceb4ea5b 16DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
cfabc2e9 17MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
789c5c57 18DOC_BUILDDEPS := asciidoc-dblatex, source-highlight, librsvg2-bin
9344ee0d 19
b965ad63
FG
20export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
21SOURCE_DATE_HUMAN := $(shell date -d "@${SOURCE_DATE_EPOCH}")
516d1f2f 22
63a01806
DM
23all: index.html
24
7515acaf
DM
25.PHONY: verify-images
26verify-images:
27 for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
516d1f2f
DM
28
29ADOC_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
e6fc3b0c
DM
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
63a01806 34
1ed794c8
DM
35pve-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
39include ./pve-doc-generator.mk
672abac1 40
9015f48f 41GEN_DEB_SOURCES= \
672abac1 42 pve-doc-generator.mk \
63a01806 43 ${MANUAL_SOURCES} \
54079101 44 pmxcfs.8-synopsis.adoc \
9344ee0d
DM
45 docinfo.xml
46
47GEN_SCRIPTS= \
8942fab2
DM
48 gen-ha-groups-opts.pl \
49 gen-ha-resources-opts.pl \
f6b81378
DM
50 gen-datacenter.cfg.5-opts.pl \
51 gen-pct.conf.5-opts.pl \
bac8c385 52 gen-pct-network-opts.pl \
fe154a4f 53 gen-pct-mountpoint-opts.pl \
9b4799ab 54 gen-qm.conf.5-opts.pl \
8eb81ff6 55 gen-qm-cloud-init-opts.pl \
500f1e1f 56 gen-vzdump.conf.5-opts.pl \
9344ee0d
DM
57 gen-pve-firewall-cluster-opts.pl \
58 gen-pve-firewall-host-opts.pl \
59 gen-pve-firewall-macros-adoc.pl \
60 gen-pve-firewall-rules-opts.pl \
441ae628
DM
61 gen-pve-firewall-vm-opts.pl \
62 gen-output-format-opts.pl
9344ee0d 63
356064f4
DM
64API_VIEWER_SOURCES= \
65 api-viewer/index.html \
66 api-viewer/apidoc.js
67
aa99b349
DM
68asciidoc-pve: asciidoc-pve.in link-refs.json
69 cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
835dd63b 70 sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
aa99b349
DM
71 chmod +x asciidoc-pve.tmp
72 mv asciidoc-pve.tmp asciidoc-pve
73
b489b02c
DM
74pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
75 cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp
76 chmod +x pve-docs-mediawiki-import.tmp
77 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
78
f4defaeb
DM
79INDEX_INCLUDES= \
80 pve-admin-guide.pdf \
f4defaeb 81 pve-admin-guide.epub \
941ab9c7
DM
82 chapter-index-table.adoc \
83 man1-index-table.adoc \
84 man5-index-table.adoc \
85 man8-index-table.adoc \
63a01806 86 $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
f4defaeb 87
b965ad63 88ADOC_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
deb7f2ea 89
fc1090ef 90BROWSER?=xdg-open
df41beec 91
9d17dbac 92README.html: README.adoc
6b70c786 93 asciidoc -a toc ${ADOC_STDARG} -o $@ $<
9d17dbac 94
8ace7110
DM
95.PHONY: index
96index: index.html
3f559975
DM
97 $(BROWSER) index.html &
98
fd02ab90
DM
99chapter-index-table.adoc: asciidoc-pve
100 ./asciidoc-pve chapter-table >$@.tmp
941ab9c7
DM
101 mv $@.tmp $@
102
fd02ab90
DM
103man1-index-table.adoc: asciidoc-pve
104 ./asciidoc-pve man1page-table >$@.tmp
941ab9c7
DM
105 mv $@.tmp $@
106
fd02ab90
DM
107man5-index-table.adoc: asciidoc-pve
108 ./asciidoc-pve man5page-table >$@.tmp
941ab9c7
DM
109 mv $@.tmp $@
110
fd02ab90
DM
111man8-index-table.adoc: asciidoc-pve
112 ./asciidoc-pve man8page-table >$@.tmp
941ab9c7
DM
113 mv $@.tmp $@
114
115index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
c65b00e2 116 asciidoc ${ADOC_STDARG} -o $@ index.adoc
deb7f2ea 117
63a01806 118pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
ae0ad291 119 asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
deb7f2ea 120
63a01806 121pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
59d89a51
DM
122 rm -rf pve-admin-guide.chunked
123 a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
59d89a51 124
2522a624 125PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
789c5c57 126PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
2522a624 127
384871f2
DM
128pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in
129 sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
130
63a01806 131pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
789c5c57
TL
132 rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
133 rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
bef0c1b4 134 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
789c5c57 135 a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc
34ef065a 136 rm proxmox-logo.pdf proxmox-ci-header.pdf
deb7f2ea 137
63a01806 138pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
2522a624 139 a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
9344ee0d 140
356064f4 141api-viewer/apidata.js: extractapi.pl
61568a65
DM
142 ./extractapi.pl >$@
143
356064f4
DM
144api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
145 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
61568a65 146
9344ee0d 147.PHONY: dinstall
cfabc2e9
DM
148dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
149 dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
9015f48f 150
9344ee0d 151.PHONY: deb
9015f48f 152deb:
c8bdafbd
WB
153 rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
154 make all-debs
9015f48f 155
f0d25f0d
WB
156.PHONY: all-debs
157all-debs: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
158
c8bdafbd
WB
159.PHONY: clean-build
160clean-build:
9015f48f 161 rm -rf build
c8bdafbd
WB
162
163define prepare_build
164 rm -rf build-$1
165 mkdir build-$1
166 cp -a debian build-$1/debian
167 mv build-$1/debian/control.in build-$1/debian/control
168 echo >> build-$1/debian/control
169 cat debian/$1.control >> build-$1/debian/control
170 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build-$1/debian/SOURCE
171 install -dm755 build-$1/usr/share/$1
172 install -dm755 build-$1/usr/share/doc/$1
173endef
174
175.PHONY: gen-deb
176gen-deb: $(GEN_DEB)
177$(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
178 $(call prepare_build,$(GEN_PACKAGE))
179 install -dm755 build-$(GEN_PACKAGE)/usr/bin
180 # install files
181 install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
182 install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
de7022fb 183 # install asciidoc-pve
c8bdafbd
WB
184 install -m 0755 asciidoc-pve build-$(GEN_PACKAGE)/usr/bin/
185 install -D -m 0644 asciidoc/mediawiki.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf
186 install -m 0644 asciidoc/asciidoc-pve.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
187 install -m 0644 asciidoc/pve-html.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
188 cd build-$(GEN_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
189 lintian ${GEN_DEB}
190
191.PHONY: doc-deb
192doc-deb: $(DOC_DEB)
193$(DOC_DEB): index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images
194 $(call prepare_build,$(DOC_PACKAGE))
421ad500 195 sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
ceb4ea5b 196 # install files for pvedocs package
c8bdafbd
WB
197 install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
198 install -dm755 build-$(DOC_PACKAGE)/usr/share/doc/${DOC_PACKAGE}
199 install -m 0644 index.html ${INDEX_INCLUDES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
200 install -m 0644 ${WIKI_IMPORTS} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
50f88938
DM
201 # install images
202 make -C images DESTDIR=../build-$(DOC_PACKAGE) install
8c8ae224 203 # install screenshot images
c8bdafbd
WB
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
61568a65 206 # install api doc viewer
c8bdafbd
WB
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
ceb4ea5b 210 lintian ${DOC_DEB}
c8bdafbd
WB
211
212.PHONY: mediawiki-deb
213mediawiki-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
cfabc2e9 218 lintian ${MEDIAWIKI_DEB}
9344ee0d 219
89e93b38 220.PHONY: upload
cfabc2e9 221upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
821cf643 222 tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pve --dist stretch
deb7f2ea 223
56122987 224.PHONY: update
0fa28023
DM
225update:
226 make clean clean-static
227 make update-static
5cb4ef63
TL
228 make all
229
230.PHONY: update-static
0fa28023
DM
231update-static:
232 make clean-static
233 make $(filter %-synopsis.adoc %-opts.adoc, ${PVE_ADMIN_GUIDE_ADOCDEPENDS}) pve-firewall-macros.adoc api-viewer/apidata.js
5cb4ef63
TL
234
235.PHONY: clean-static
236clean-static:
5bf279bd 237 find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
56122987 238 rm -f api-viewer/apidata.js
fe154a4f 239 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
deb7f2ea 240
5cb4ef63 241clean:
f00afaef
WB
242 rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
243 rm -f *.deb *.changes *.buildinfo
5cb4ef63
TL
244 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
245 rm -rf .pve-doc-depends
f00afaef 246 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
c8bdafbd 247 rm -rf build-*