Commit | Line | Data |
---|---|---|
bef0c1b4 DM |
1 | DGDIR=. |
2 | ||
3 | include ./pve-doc-generator.mk | |
deb7f2ea | 4 | |
9015f48f DM |
5 | GEN_PACKAGE=pve-doc-generator |
6 | DOC_PACKAGE=pve-docs | |
cfabc2e9 | 7 | MEDIAWIKI_PACKAGE=pve-docs-mediawiki |
9344ee0d DM |
8 | |
9 | # also update debian/changelog | |
dfb496c5 | 10 | PKGREL=3 |
9344ee0d | 11 | |
b4f3c18a DM |
12 | GITVERSION:=$(shell cat .git/refs/heads/master) |
13 | ||
0a3c58e0 TL |
14 | ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH) |
15 | ||
16 | GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb | |
ceb4ea5b | 17 | DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb |
cfabc2e9 | 18 | MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb |
9344ee0d | 19 | |
f96bdfd8 | 20 | CHAPTER_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 |
35 | STORAGE_TYPES= \ |
36 | dir \ | |
37 | glusterfs \ | |
38 | iscsi \ | |
39 | iscsidirect \ | |
40 | lvm \ | |
41 | lvmthin \ | |
42 | nfs \ | |
43 | rbd \ | |
44 | zfspool | |
f96bdfd8 | 45 | |
ebd2a7fb DM |
46 | COMMAND_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 |
59 | SERVICE_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 | |
69 | CONFIG_LIST=datacenter.cfg qm.conf pct.conf | |
70 | ||
9015f48f | 71 | GEN_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 | ||
90 | GEN_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 | 103 | INSTALLATION_SOURCES= \ |
5c6cf7ac | 104 | pve-usbstick.adoc \ |
6b5fc47b DM |
105 | pve-installation.adoc |
106 | ||
8c80c3fc DM |
107 | SYSADMIN_PARTS= \ |
108 | getting-help \ | |
109 | pve-network \ | |
110 | pve-package-repos \ | |
8c80c3fc | 111 | system-software-updates \ |
8b849dc3 | 112 | local-lvm \ |
8c80c3fc DM |
113 | local-zfs |
114 | ||
672abac1 | 115 | SYSADMIN_SOURCES= \ |
8c80c3fc | 116 | $(addsuffix .adoc, ${SYSADMIN_PARTS}) \ |
d91f8c1e DM |
117 | sysadmin.adoc |
118 | ||
356064f4 DM |
119 | API_VIEWER_SOURCES= \ |
120 | api-viewer/index.html \ | |
121 | api-viewer/apidoc.js | |
122 | ||
672abac1 DM |
123 | PVE_ADMIN_GUIDE_SOURCES= \ |
124 | ${DATACENTER_CONF_MAN5_SOURCES} \ | |
125 | ${QM_CONF_MAN5_SOURCES} \ | |
126 | ${PCT_CONF_MAN5_SOURCES} \ | |
127 | ${SYSADMIN_SOURCES} \ | |
128 | pve-admin-guide.adoc \ | |
129 | pve-intro.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 | 159 | WIKI_IMPORTS= \ |
5c6cf7ac | 160 | section-pve-usbstick-plain.html \ |
8c80c3fc DM |
161 | $(addsuffix -plain.html, $(addprefix sysadmin-, ${SYSADMIN_PARTS})) \ |
162 | $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST})) \ | |
163 | $(addsuffix .5-plain.html, ${CONFIG_LIST}) \ | |
251666be DM |
164 | $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES})) |
165 | ||
f4defaeb DM |
166 | INDEX_INCLUDES= \ |
167 | pve-admin-guide.pdf \ | |
168 | pve-admin-guide.html \ | |
169 | pve-admin-guide.epub \ | |
170 | $(addsuffix .1.html, ${COMMAND_LIST}) \ | |
171 | $(addsuffix .8.html, ${SERVICE_LIST}) \ | |
172 | $(addsuffix .5.html, ${CONFIG_LIST}) \ | |
251666be | 173 | $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST})) |
f4defaeb | 174 | |
0e25828e DM |
175 | ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" |
176 | ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} | |
177 | ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} | |
178 | ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} | |
deb7f2ea | 179 | |
fc1090ef | 180 | BROWSER?=xdg-open |
df41beec | 181 | |
56122987 | 182 | all: index.html |
7b2c36ae | 183 | |
deb7f2ea DM |
184 | %-nwdiag.svg: %.nwdiag |
185 | nwdiag -T svg $*.nwdiag -o $@; | |
186 | ||
8c80c3fc | 187 | sysadmin-%-plain.html: %.adoc |
52bc5baa | 188 | asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc |
8c80c3fc | 189 | |
5c6cf7ac DM |
190 | section-%-plain.html: %.adoc |
191 | asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc | |
192 | ||
9ee94323 DM |
193 | chapter-sysadmin.html chapter-sysadmin-plain.html: ${SYSADMIN_SOURCES} |
194 | ||
f96bdfd8 | 195 | chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES} |
d01fa25d | 196 | asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc |
f96bdfd8 | 197 | |
0e25828e | 198 | chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES} |
251666be DM |
199 | asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc |
200 | ||
201 | pve-storage-%-plain.html: pve-storage-%.adoc ${PVE_COMMON_DOC_SOURCES} | |
202 | asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ pve-storage-$*.adoc | |
0e25828e | 203 | |
bd88f9d9 | 204 | %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} |
deb7f2ea | 205 | asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc |
deb7f2ea | 206 | |
7c40c631 DM |
207 | pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES} |
208 | asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc | |
deb7f2ea | 209 | |
7c40c631 | 210 | %.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} |
deb7f2ea | 211 | asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc |
71e16346 | 212 | |
7c40c631 | 213 | %.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} |
c016ebb7 | 214 | asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc |
c016ebb7 | 215 | |
1496dbe5 DM |
216 | %.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} |
217 | asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc | |
1496dbe5 | 218 | |
9d17dbac DM |
219 | README.html: README.adoc |
220 | asciidoc ${ADOC_STDARG} -o $@ $< | |
221 | ||
8ace7110 DM |
222 | .PHONY: index |
223 | index: index.html | |
3f559975 DM |
224 | $(BROWSER) index.html & |
225 | ||
f4defaeb | 226 | index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} |
bef0c1b4 | 227 | asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc |
deb7f2ea DM |
228 | |
229 | pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES} | |
683e3b93 | 230 | asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc |
deb7f2ea | 231 | |
59d89a51 DM |
232 | pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES} |
233 | rm -rf pve-admin-guide.chunked | |
234 | a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc | |
59d89a51 | 235 | |
66f81679 | 236 | pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml |
34ef065a | 237 | inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg |
333a2f49 | 238 | inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg |
bef0c1b4 | 239 | grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false); |
72470ed6 | 240 | 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 | 241 | rm proxmox-logo.pdf proxmox-ci-header.pdf |
deb7f2ea DM |
242 | |
243 | pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES} | |
244 | a2x -f epub pve-admin-guide.adoc | |
9344ee0d | 245 | |
356064f4 | 246 | api-viewer/apidata.js: extractapi.pl |
61568a65 DM |
247 | ./extractapi.pl >$@ |
248 | ||
356064f4 DM |
249 | api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js |
250 | cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@ | |
61568a65 | 251 | |
9344ee0d | 252 | .PHONY: dinstall |
cfabc2e9 DM |
253 | dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
254 | dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | |
9015f48f | 255 | |
9344ee0d | 256 | .PHONY: deb |
9015f48f | 257 | deb: |
cfabc2e9 DM |
258 | rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; |
259 | make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; | |
9015f48f | 260 | |
cfabc2e9 | 261 | ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} |
9015f48f DM |
262 | rm -rf build |
263 | mkdir build | |
ceb4ea5b DM |
264 | rsync -a debian/ build/debian |
265 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE | |
266 | # install files for pve-doc-generator package | |
267 | mkdir -p build/usr/share/${GEN_PACKAGE} | |
268 | mkdir -p build/usr/share/doc/${GEN_PACKAGE} | |
269 | install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE} | |
270 | install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE} | |
271 | # install files for pvedocs package | |
9015f48f DM |
272 | mkdir -p build/usr/share/${DOC_PACKAGE} |
273 | mkdir -p build/usr/share/doc/${DOC_PACKAGE} | |
ad2bfc41 | 274 | install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE} |
251666be | 275 | install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE} |
61568a65 | 276 | # install api doc viewer |
356064f4 DM |
277 | mkdir build/usr/share/${DOC_PACKAGE}/api-viewer |
278 | install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer | |
cfabc2e9 | 279 | # build Debian packages |
9344ee0d | 280 | cd build; dpkg-buildpackage -rfakeroot -b -us -uc |
9015f48f | 281 | lintian ${GEN_DEB} |
ceb4ea5b | 282 | lintian ${DOC_DEB} |
cfabc2e9 | 283 | lintian ${MEDIAWIKI_DEB} |
9344ee0d | 284 | |
89e93b38 | 285 | .PHONY: upload |
cfabc2e9 | 286 | upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} |
d7b4925a | 287 | tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload |
deb7f2ea | 288 | |
56122987 | 289 | .PHONY: update |
c016ebb7 | 290 | update: clean |
7aacca6f | 291 | rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc |
56122987 | 292 | rm -f api-viewer/apidata.js |
fe154a4f | 293 | rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc |
c016ebb7 | 294 | make all |
deb7f2ea | 295 | |
bca311e4 | 296 | clean: |
34ef065a | 297 | 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 | 298 | find . -name '*~' -exec rm {} ';' |