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