]> git.proxmox.com Git - pve-docs.git/blame - Makefile
cleanup: getting-help.adoc is no longer part of sysadmin.adoc
[pve-docs.git] / Makefile
CommitLineData
bef0c1b4
DM
1DGDIR=.
2
3include ./pve-doc-generator.mk
deb7f2ea 4
9015f48f
DM
5GEN_PACKAGE=pve-doc-generator
6DOC_PACKAGE=pve-docs
cfabc2e9 7MEDIAWIKI_PACKAGE=pve-docs-mediawiki
9344ee0d
DM
8
9# also update debian/changelog
dfb496c5 10PKGREL=3
9344ee0d 11
b4f3c18a
DM
12GITVERSION:=$(shell cat .git/refs/heads/master)
13
0a3c58e0
TL
14ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
15
16GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
ceb4ea5b 17DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
cfabc2e9 18MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
9344ee0d 19
f96bdfd8 20CHAPTER_LIST= \
6b5fc47b 21 pve-installation \
f96bdfd8
DM
22 sysadmin \
23 pvecm \
24 pmxcfs \
25 pvesm \
26 qm \
27 pve-firewall \
28 pveum \
29 pct \
30 ha-manager \
31 vzdump \
32 pve-faq \
33 pve-bibliography
34
251666be
DM
35STORAGE_TYPES= \
36 dir \
37 glusterfs \
38 iscsi \
39 iscsidirect \
40 lvm \
41 lvmthin \
42 nfs \
43 rbd \
44 zfspool
f96bdfd8 45
ebd2a7fb
DM
46COMMAND_LIST= \
47 pvesubscription \
48 pvecm \
49 qm \
50 qmrestore \
0840a663 51 pveceph \
ebd2a7fb
DM
52 pct \
53 pveam \
54 pvesm \
55 pveum \
56 vzdump \
57 ha-manager
672abac1 58
96f2beeb
DM
59SERVICE_LIST= \
60 pve-firewall \
61 pve-ha-crm \
62 pve-ha-lrm \
63 pvestatd \
64 pmxcfs \
65 pveproxy \
2d8f1c92 66 spiceproxy \
96f2beeb 67 pvedaemon
672abac1
DM
68
69CONFIG_LIST=datacenter.cfg qm.conf pct.conf
70
9015f48f 71GEN_DEB_SOURCES= \
672abac1
DM
72 pve-doc-generator.mk \
73 attributes.txt \
74 $(addsuffix .adoc, ${COMMAND_LIST}) \
75 $(addsuffix .adoc, ${SERVICE_LIST}) \
76 $(addsuffix .adoc, ${CONFIG_LIST}) \
77 pve-storage-dir.adoc \
78 pve-storage-glusterfs.adoc \
79 pve-storage-iscsi.adoc \
80 pve-storage-iscsidirect.adoc \
81 pve-storage-lvm.adoc \
82141a78 82 pve-storage-lvmthin.adoc \
672abac1
DM
83 pve-storage-nfs.adoc \
84 pve-storage-rbd.adoc \
85 pve-storage-zfspool.adoc \
bd88f9d9 86 pmxcfs.8-cli.adoc \
672abac1 87 pve-copyright.adoc \
9344ee0d
DM
88 docinfo.xml
89
90GEN_SCRIPTS= \
f6b81378
DM
91 gen-datacenter.cfg.5-opts.pl \
92 gen-pct.conf.5-opts.pl \
bac8c385 93 gen-pct-network-opts.pl \
fe154a4f 94 gen-pct-mountpoint-opts.pl \
9b4799ab 95 gen-qm.conf.5-opts.pl \
500f1e1f 96 gen-vzdump.conf.5-opts.pl \
9344ee0d
DM
97 gen-pve-firewall-cluster-opts.pl \
98 gen-pve-firewall-host-opts.pl \
99 gen-pve-firewall-macros-adoc.pl \
100 gen-pve-firewall-rules-opts.pl \
f6b81378 101 gen-pve-firewall-vm-opts.pl
9344ee0d 102
6b5fc47b 103INSTALLATION_SOURCES= \
5c6cf7ac 104 pve-usbstick.adoc \
6b5fc47b
DM
105 pve-installation.adoc
106
8c80c3fc 107SYSADMIN_PARTS= \
8c80c3fc
DM
108 pve-network \
109 pve-package-repos \
8c80c3fc 110 system-software-updates \
8b849dc3 111 local-lvm \
8c80c3fc
DM
112 local-zfs
113
672abac1 114SYSADMIN_SOURCES= \
8c80c3fc 115 $(addsuffix .adoc, ${SYSADMIN_PARTS}) \
d91f8c1e
DM
116 sysadmin.adoc
117
356064f4
DM
118API_VIEWER_SOURCES= \
119 api-viewer/index.html \
120 api-viewer/apidoc.js
121
672abac1
DM
122PVE_ADMIN_GUIDE_SOURCES= \
123 ${DATACENTER_CONF_MAN5_SOURCES} \
124 ${QM_CONF_MAN5_SOURCES} \
125 ${PCT_CONF_MAN5_SOURCES} \
126 ${SYSADMIN_SOURCES} \
127 pve-admin-guide.adoc \
128 pve-intro.adoc \
86f58817 129 getting-help.adoc \
6b5fc47b 130 ${INSTALLATION_SOURCES} \
672abac1 131 pmxcfs.adoc \
bd88f9d9 132 pmxcfs.8-cli.adoc \
672abac1
DM
133 pve-faq.adoc \
134 ${PVE_FIREWALL_MAN8_SOURCES} \
135 ${PVESM_MAN1_SOURCES} \
136 ${PCT_MAN1_SOURCES} \
137 ${PVECM_MAN1_SOURCES} \
138 ${PVEUM_MAN1_SOURCES} \
139 ${QM_MAN1_SOURCES} \
140 ${QMRESTORE_MAN1_SOURCES} \
141 ${HA_MANAGER_MAN1_SOURCES} \
2d8f1c92
DM
142 ${PVESTATD_MAN8_SOURCES} \
143 ${PVEDAEMON_MAN8_SOURCES} \
144 ${PVEPROXY_MAN8_SOURCES} \
145 ${SPICEPROXY_MAN8_SOURCES} \
672abac1
DM
146 ${PVE_HA_CRM_MAN8_SOURCES} \
147 ${PVE_HA_LRM_MAN8_SOURCES} \
6198e7c5
DM
148 ${VZDUMP_MAN1_SOURCES} \
149 ${PVEAM_MAN1_SOURCES} \
ebd2a7fb 150 ${PVESUBSCRIPTION_MAN1_SOURCES} \
0840a663 151 ${PVECEPH_MAN1_SOURCES} \
672abac1
DM
152 pve-bibliography.adoc \
153 $(addsuffix .adoc, ${COMMAND_LIST}) \
154 $(addsuffix .adoc, ${SERVICE_LIST}) \
155 $(addsuffix .adoc, ${CONFIG_LIST}) \
156 GFDL.adoc \
deb7f2ea
DM
157 attributes.txt
158
8c80c3fc 159WIKI_IMPORTS= \
5c6cf7ac 160 section-pve-usbstick-plain.html \
86f58817 161 section-getting-help-plain.html \
8c80c3fc
DM
162 $(addsuffix -plain.html, $(addprefix sysadmin-, ${SYSADMIN_PARTS})) \
163 $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST})) \
164 $(addsuffix .5-plain.html, ${CONFIG_LIST}) \
251666be
DM
165 $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES}))
166
f4defaeb
DM
167INDEX_INCLUDES= \
168 pve-admin-guide.pdf \
169 pve-admin-guide.html \
170 pve-admin-guide.epub \
171 $(addsuffix .1.html, ${COMMAND_LIST}) \
172 $(addsuffix .8.html, ${SERVICE_LIST}) \
173 $(addsuffix .5.html, ${CONFIG_LIST}) \
251666be 174 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
f4defaeb 175
0e25828e
DM
176ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
177ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG}
178ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG}
179ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG}
deb7f2ea 180
fc1090ef 181BROWSER?=xdg-open
df41beec 182
56122987 183all: index.html
7b2c36ae 184
deb7f2ea
DM
185%-nwdiag.svg: %.nwdiag
186 nwdiag -T svg $*.nwdiag -o $@;
187
8c80c3fc 188sysadmin-%-plain.html: %.adoc
52bc5baa 189 asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
8c80c3fc 190
5c6cf7ac
DM
191section-%-plain.html: %.adoc
192 asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
193
9ee94323
DM
194chapter-sysadmin.html chapter-sysadmin-plain.html: ${SYSADMIN_SOURCES}
195
f96bdfd8 196chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
d01fa25d 197 asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc
f96bdfd8 198
0e25828e 199chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
251666be
DM
200 asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc
201
202pve-storage-%-plain.html: pve-storage-%.adoc ${PVE_COMMON_DOC_SOURCES}
203 asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ pve-storage-$*.adoc
0e25828e 204
bd88f9d9 205%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea 206 asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
deb7f2ea 207
7c40c631
DM
208pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
209 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
deb7f2ea 210
7c40c631 211%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea 212 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
71e16346 213
7c40c631 214%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
c016ebb7 215 asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
c016ebb7 216
1496dbe5
DM
217%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
218 asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
1496dbe5 219
9d17dbac
DM
220README.html: README.adoc
221 asciidoc ${ADOC_STDARG} -o $@ $<
222
8ace7110
DM
223.PHONY: index
224index: index.html
3f559975
DM
225 $(BROWSER) index.html &
226
f4defaeb 227index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
bef0c1b4 228 asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
deb7f2ea
DM
229
230pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
683e3b93 231 asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
deb7f2ea 232
59d89a51
DM
233pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
234 rm -rf pve-admin-guide.chunked
235 a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
59d89a51 236
66f81679 237pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
34ef065a 238 inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
333a2f49 239 inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
bef0c1b4 240 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
72470ed6 241 a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" --dblatex-opts "-P doc.section.depth=2 -P toc.section.depth=2" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc-dblatex-custom.sty" pve-admin-guide.adoc
34ef065a 242 rm proxmox-logo.pdf proxmox-ci-header.pdf
deb7f2ea
DM
243
244pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
245 a2x -f epub pve-admin-guide.adoc
9344ee0d 246
356064f4 247api-viewer/apidata.js: extractapi.pl
61568a65
DM
248 ./extractapi.pl >$@
249
356064f4
DM
250api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
251 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
61568a65 252
9344ee0d 253.PHONY: dinstall
cfabc2e9
DM
254dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
255 dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
9015f48f 256
9344ee0d 257.PHONY: deb
9015f48f 258deb:
cfabc2e9
DM
259 rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
260 make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
9015f48f 261
cfabc2e9 262${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES}
9015f48f
DM
263 rm -rf build
264 mkdir build
ceb4ea5b
DM
265 rsync -a debian/ build/debian
266 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
267 # install files for pve-doc-generator package
268 mkdir -p build/usr/share/${GEN_PACKAGE}
269 mkdir -p build/usr/share/doc/${GEN_PACKAGE}
270 install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
271 install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
272 # install files for pvedocs package
9015f48f
DM
273 mkdir -p build/usr/share/${DOC_PACKAGE}
274 mkdir -p build/usr/share/doc/${DOC_PACKAGE}
ad2bfc41 275 install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE}
251666be 276 install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE}
61568a65 277 # install api doc viewer
356064f4
DM
278 mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
279 install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
cfabc2e9 280 # build Debian packages
9344ee0d 281 cd build; dpkg-buildpackage -rfakeroot -b -us -uc
9015f48f 282 lintian ${GEN_DEB}
ceb4ea5b 283 lintian ${DOC_DEB}
cfabc2e9 284 lintian ${MEDIAWIKI_DEB}
9344ee0d 285
89e93b38 286.PHONY: upload
cfabc2e9 287upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
d7b4925a 288 tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
deb7f2ea 289
56122987 290.PHONY: update
c016ebb7 291update: clean
7aacca6f 292 rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc
56122987 293 rm -f api-viewer/apidata.js
fe154a4f 294 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
c016ebb7 295 make all
deb7f2ea 296
bca311e4 297clean:
34ef065a 298 rm -rf *.tmp.xml *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html chapter-*-plain.html chapter-*.html pve-admin-guide.chunked
de9cbbd6 299 find . -name '*~' -exec rm {} ';'