]> git.proxmox.com Git - pve-docs.git/blame - Makefile
move 'Installation' into its own chapter
[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
DM
103INSTALLATION_SOURCES= \
104 pve-installation.adoc
105
8c80c3fc
DM
106SYSADMIN_PARTS= \
107 getting-help \
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 \
6b5fc47b 129 ${INSTALLATION_SOURCES} \
672abac1 130 pmxcfs.adoc \
bd88f9d9 131 pmxcfs.8-cli.adoc \
672abac1
DM
132 pve-faq.adoc \
133 ${PVE_FIREWALL_MAN8_SOURCES} \
134 ${PVESM_MAN1_SOURCES} \
135 ${PCT_MAN1_SOURCES} \
136 ${PVECM_MAN1_SOURCES} \
137 ${PVEUM_MAN1_SOURCES} \
138 ${QM_MAN1_SOURCES} \
139 ${QMRESTORE_MAN1_SOURCES} \
140 ${HA_MANAGER_MAN1_SOURCES} \
2d8f1c92
DM
141 ${PVESTATD_MAN8_SOURCES} \
142 ${PVEDAEMON_MAN8_SOURCES} \
143 ${PVEPROXY_MAN8_SOURCES} \
144 ${SPICEPROXY_MAN8_SOURCES} \
672abac1
DM
145 ${PVE_HA_CRM_MAN8_SOURCES} \
146 ${PVE_HA_LRM_MAN8_SOURCES} \
6198e7c5
DM
147 ${VZDUMP_MAN1_SOURCES} \
148 ${PVEAM_MAN1_SOURCES} \
ebd2a7fb 149 ${PVESUBSCRIPTION_MAN1_SOURCES} \
0840a663 150 ${PVECEPH_MAN1_SOURCES} \
672abac1
DM
151 pve-bibliography.adoc \
152 $(addsuffix .adoc, ${COMMAND_LIST}) \
153 $(addsuffix .adoc, ${SERVICE_LIST}) \
154 $(addsuffix .adoc, ${CONFIG_LIST}) \
155 GFDL.adoc \
deb7f2ea
DM
156 attributes.txt
157
8c80c3fc
DM
158WIKI_IMPORTS= \
159 $(addsuffix -plain.html, $(addprefix sysadmin-, ${SYSADMIN_PARTS})) \
160 $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST})) \
161 $(addsuffix .5-plain.html, ${CONFIG_LIST}) \
251666be
DM
162 $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES}))
163
f4defaeb
DM
164INDEX_INCLUDES= \
165 pve-admin-guide.pdf \
166 pve-admin-guide.html \
167 pve-admin-guide.epub \
168 $(addsuffix .1.html, ${COMMAND_LIST}) \
169 $(addsuffix .8.html, ${SERVICE_LIST}) \
170 $(addsuffix .5.html, ${CONFIG_LIST}) \
251666be 171 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
f4defaeb 172
0e25828e
DM
173ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
174ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG}
175ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG}
176ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG}
deb7f2ea 177
fc1090ef 178BROWSER?=xdg-open
df41beec 179
56122987 180all: index.html
7b2c36ae 181
deb7f2ea
DM
182%-nwdiag.svg: %.nwdiag
183 nwdiag -T svg $*.nwdiag -o $@;
184
8c80c3fc 185sysadmin-%-plain.html: %.adoc
52bc5baa 186 asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
8c80c3fc 187
9ee94323
DM
188chapter-sysadmin.html chapter-sysadmin-plain.html: ${SYSADMIN_SOURCES}
189
f96bdfd8 190chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
d01fa25d 191 asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc
f96bdfd8 192
0e25828e 193chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
251666be
DM
194 asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc
195
196pve-storage-%-plain.html: pve-storage-%.adoc ${PVE_COMMON_DOC_SOURCES}
197 asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ pve-storage-$*.adoc
0e25828e 198
bd88f9d9 199%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea 200 asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
deb7f2ea 201
7c40c631
DM
202pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
203 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
deb7f2ea 204
7c40c631 205%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea 206 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
71e16346 207
7c40c631 208%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
c016ebb7 209 asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
c016ebb7 210
1496dbe5
DM
211%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
212 asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
1496dbe5 213
9d17dbac
DM
214README.html: README.adoc
215 asciidoc ${ADOC_STDARG} -o $@ $<
216
8ace7110
DM
217.PHONY: index
218index: index.html
3f559975
DM
219 $(BROWSER) index.html &
220
f4defaeb 221index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
bef0c1b4 222 asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
deb7f2ea
DM
223
224pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
683e3b93 225 asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
deb7f2ea 226
59d89a51
DM
227pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
228 rm -rf pve-admin-guide.chunked
229 a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
59d89a51 230
66f81679 231pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
34ef065a 232 inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
333a2f49 233 inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
bef0c1b4 234 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
72470ed6 235 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 236 rm proxmox-logo.pdf proxmox-ci-header.pdf
deb7f2ea
DM
237
238pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
239 a2x -f epub pve-admin-guide.adoc
9344ee0d 240
356064f4 241api-viewer/apidata.js: extractapi.pl
61568a65
DM
242 ./extractapi.pl >$@
243
356064f4
DM
244api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
245 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
61568a65 246
9344ee0d 247.PHONY: dinstall
cfabc2e9
DM
248dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
249 dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
9015f48f 250
9344ee0d 251.PHONY: deb
9015f48f 252deb:
cfabc2e9
DM
253 rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
254 make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
9015f48f 255
cfabc2e9 256${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES}
9015f48f
DM
257 rm -rf build
258 mkdir build
ceb4ea5b
DM
259 rsync -a debian/ build/debian
260 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
261 # install files for pve-doc-generator package
262 mkdir -p build/usr/share/${GEN_PACKAGE}
263 mkdir -p build/usr/share/doc/${GEN_PACKAGE}
264 install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
265 install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
266 # install files for pvedocs package
9015f48f
DM
267 mkdir -p build/usr/share/${DOC_PACKAGE}
268 mkdir -p build/usr/share/doc/${DOC_PACKAGE}
ad2bfc41 269 install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE}
251666be 270 install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE}
61568a65 271 # install api doc viewer
356064f4
DM
272 mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
273 install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
cfabc2e9 274 # build Debian packages
9344ee0d 275 cd build; dpkg-buildpackage -rfakeroot -b -us -uc
9015f48f 276 lintian ${GEN_DEB}
ceb4ea5b 277 lintian ${DOC_DEB}
cfabc2e9 278 lintian ${MEDIAWIKI_DEB}
9344ee0d 279
89e93b38 280.PHONY: upload
cfabc2e9 281upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
d7b4925a 282 tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
deb7f2ea 283
56122987 284.PHONY: update
c016ebb7 285update: clean
7aacca6f 286 rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc
56122987 287 rm -f api-viewer/apidata.js
fe154a4f 288 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
c016ebb7 289 make all
deb7f2ea 290
bca311e4 291clean:
34ef065a 292 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 293 find . -name '*~' -exec rm {} ';'