2 ASCIIDOC_PVE
=.
/asciidoc-pve
4 include .
/pve-doc-generator.mk
6 GEN_PACKAGE
=pve-doc-generator
8 MEDIAWIKI_PACKAGE
=pve-docs-mediawiki
10 # also update debian/changelog
13 GITVERSION
:=$(shell cat .git
/refs
/heads
/master
)
15 ARCH
:=$(shell dpkg-architecture
-qDEB_BUILD_ARCH
)
17 GEN_DEB
=${GEN_PACKAGE}_
${DOCRELEASE}-${PKGREL}_
${ARCH}.deb
18 DOC_DEB
=${DOC_PACKAGE}_
${DOCRELEASE}-${PKGREL}_all.deb
19 MEDIAWIKI_DEB
=${MEDIAWIKI_PACKAGE}_
${DOCRELEASE}-${PKGREL}_all.deb
71 CONFIG_LIST
=datacenter.cfg qm.conf pct.conf
74 pve-doc-generator.mk \
76 $(addsuffix .adoc
, ${COMMAND_LIST}) \
77 $(addsuffix .adoc
, ${SERVICE_LIST}) \
78 $(addsuffix .adoc
, ${CONFIG_LIST}) \
79 pve-storage-dir.adoc \
80 pve-storage-glusterfs.adoc \
81 pve-storage-iscsi.adoc \
82 pve-storage-iscsidirect.adoc \
83 pve-storage-lvm.adoc \
84 pve-storage-lvmthin.adoc \
85 pve-storage-nfs.adoc \
86 pve-storage-rbd.adoc \
87 pve-storage-zfspool.adoc \
93 gen-datacenter.cfg
.5-opts.pl \
94 gen-pct.conf
.5-opts.pl \
95 gen-pct-network-opts.pl \
96 gen-pct-mountpoint-opts.pl \
97 gen-qm.conf
.5-opts.pl \
98 gen-vzdump.conf
.5-opts.pl \
99 gen-pve-firewall-cluster-opts.pl \
100 gen-pve-firewall-host-opts.pl \
101 gen-pve-firewall-macros-adoc.pl \
102 gen-pve-firewall-rules-opts.pl \
103 gen-pve-firewall-vm-opts.pl
105 INSTALLATION_SOURCES
= \
107 pve-system-requirements.adoc \
108 pve-installation.adoc
113 system-software-updates \
114 pve-disk-health-monitoring \
120 $(addsuffix .adoc
, ${SYSADMIN_PARTS}) \
123 API_VIEWER_SOURCES
= \
124 api-viewer
/index.html \
127 PVE_ADMIN_GUIDE_SOURCES
= \
128 ${DATACENTER_CONF_MAN5_SOURCES} \
129 ${QM_CONF_MAN5_SOURCES} \
130 ${PCT_CONF_MAN5_SOURCES} \
131 ${SYSADMIN_SOURCES} \
132 pve-admin-guide.adoc \
135 ${INSTALLATION_SOURCES} \
139 ${PVE_FIREWALL_MAN8_SOURCES} \
140 ${PVESM_MAN1_SOURCES} \
141 ${PCT_MAN1_SOURCES} \
142 ${PVECM_MAN1_SOURCES} \
143 ${PVEUM_MAN1_SOURCES} \
145 ${QMRESTORE_MAN1_SOURCES} \
146 ${HA_MANAGER_MAN1_SOURCES} \
147 ${PVESTATD_MAN8_SOURCES} \
148 ${PVEDAEMON_MAN8_SOURCES} \
149 ${PVEPROXY_MAN8_SOURCES} \
150 ${SPICEPROXY_MAN8_SOURCES} \
151 ${PVE_HA_CRM_MAN8_SOURCES} \
152 ${PVE_HA_LRM_MAN8_SOURCES} \
153 ${VZDUMP_MAN1_SOURCES} \
154 ${PVEAM_MAN1_SOURCES} \
155 ${PVESUBSCRIPTION_MAN1_SOURCES} \
156 ${PVECEPH_MAN1_SOURCES} \
157 ${PVEPERF_MAN1_SOURCES} \
158 pve-bibliography.adoc \
159 $(addsuffix .adoc
, ${COMMAND_LIST}) \
160 $(addsuffix .adoc
, ${SERVICE_LIST}) \
161 $(addsuffix .adoc
, ${CONFIG_LIST}) \
165 link-refs.json
: scan-adoc-refs
${PVE_ADMIN_GUIDE_SOURCES}
166 .
/scan-adoc-refs
${PVE_ADMIN_GUIDE_SOURCES} >link-refs.json
168 asciidoc-pve
: asciidoc-pve.in link-refs.json
169 cat asciidoc-pve.in link-refs.json
>asciidoc-pve.tmp
170 sed
-e s
/@RELEASE@
/${DOCRELEASE}/ -i asciidoc-pve.tmp
171 chmod
+x asciidoc-pve.tmp
172 mv asciidoc-pve.tmp asciidoc-pve
174 pve-docs-mediawiki-import
: pve-docs-mediawiki-import.in link-refs.json
175 cat pve-docs-mediawiki-import.in link-refs.json
> pve-docs-mediawiki-import.tmp
176 chmod
+x pve-docs-mediawiki-import.tmp
177 mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
180 pve-usbstick-plain.html \
181 getting-help-plain.html \
182 pve-system-requirements-plain.html \
183 $(addsuffix -plain.html
, ${SYSADMIN_PARTS}) \
184 $(addsuffix -plain.html
, ${CHAPTER_LIST}) \
185 $(addsuffix .5-plain.html
, ${CONFIG_LIST}) \
186 $(addsuffix -plain.html
, $(addprefix pve-storage-
, ${STORAGE_TYPES}))
189 pve-admin-guide.pdf \
190 pve-admin-guide.html \
191 pve-admin-guide.epub \
192 $(addsuffix .1.html
, ${COMMAND_LIST}) \
193 $(addsuffix .8.html
, ${SERVICE_LIST}) \
194 $(addsuffix .5.html
, ${CONFIG_LIST}) \
195 $(addsuffix .html
, $(addprefix chapter-
, ${CHAPTER_LIST}))
197 ADOC_STDARG
= -a icons
-a data-uri
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}"
198 ADOC_MAN1_HTML_ARGS
=-a
"manvolnum=1" ${ADOC_STDARG}
199 ADOC_MAN5_HTML_ARGS
=-a
"manvolnum=5" ${ADOC_STDARG}
200 ADOC_MAN8_HTML_ARGS
=-a
"manvolnum=8" ${ADOC_STDARG}
206 %-nwdiag.svg
: %.nwdiag
207 nwdiag
-T svg
$*.nwdiag
-o
$@
;
209 %-plain.html
: asciidoc-pve
%.adoc
210 .
/asciidoc-pve compile-wiki
-o
$@
$*.adoc
212 chapter-sysadmin.html sysadmin-plain.html
: ${SYSADMIN_SOURCES}
214 chapter-
%.html
: %.adoc asciidoc-pve
${PVE_COMMON_DOC_SOURCES}
215 .
/asciidoc-pve compile-chapter
-o
$@
$*.adoc
217 %.1.html
: %.adoc
%.1-synopsis.adoc asciidoc-pve
${PVE_COMMON_DOC_SOURCES}
218 .
/asciidoc-pve compile-man-html
-o
$@
$*.adoc
220 pmxcfs
.8.html
: pmxcfs.adoc pmxcfs
.8-cli.adoc asciidoc-pve
${PVE_COMMON_DOC_SOURCES}
221 .
/asciidoc-pve compile-man-html
-o
$@ pmxcfs.adoc
223 %.8.html
: %.adoc
%.8-synopsis.adoc asciidoc-pve
${PVE_COMMON_DOC_SOURCES}
224 .
/asciidoc-pve compile-man-html
-o
$@
$*.adoc
226 %.5.html
: %.adoc
%.5-opts.adoc asciidoc-pve
${PVE_COMMON_DOC_SOURCES}
227 .
/asciidoc-pve compile-man-html
-o
$@
$*.adoc
229 %.5-plain.html
: %.adoc
%.5-opts.adoc asciidoc-pve
${PVE_COMMON_DOC_SOURCES}
230 .
/asciidoc-pve compile-man-wiki
-o
$@
$*.adoc
232 README.html
: README.adoc
233 asciidoc
${ADOC_STDARG} -o
$@
$<
237 $(BROWSER
) index.html
&
239 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
240 asciidoc
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}" index.adoc
242 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_SOURCES}
243 asciidoc
-a pvelogo
-a
"revnumber=${DOCRELEASE}" -a
"date=$(shell date)" pve-admin-guide.adoc
245 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_SOURCES}
246 rm -rf pve-admin-guide.chunked
247 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
249 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
250 inkscape
-z
-D
--export-pdf
=proxmox-logo.pdf images
/proxmox-logo.svg
251 inkscape
-z
-D
--export-pdf
=proxmox-ci-header.pdf images
/proxmox-ci-header.svg
252 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
253 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
254 rm proxmox-logo.pdf proxmox-ci-header.pdf
256 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_SOURCES}
257 a2x
-f epub pve-admin-guide.adoc
259 api-viewer
/apidata.js
: extractapi.pl
262 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
263 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
266 dinstall
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
267 dpkg
-i
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
271 rm -f
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
272 make
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
274 ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html
${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import
277 rsync
-a debian
/ build
/debian
278 cp pve-docs-mediawiki-import build
/debian
/tree
/pve-docs-mediawiki
/pve-docs-mediawiki-import
279 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/debian
/SOURCE
280 # install files for pve-doc-generator package
281 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
282 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
283 mkdir
-p build
/usr
/bin
284 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
285 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
286 install -m
0755 asciidoc-pve build
/usr
/bin
/
287 # install files for pvedocs package
288 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
289 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
290 install -m
0644 index.html
${INDEX_INCLUDES} build
/usr
/share
/${DOC_PACKAGE}
291 install -m
0644 ${WIKI_IMPORTS} build
/usr
/share
/${DOC_PACKAGE}
292 # install api doc viewer
293 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
294 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
295 # build Debian packages
296 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
299 lintian
${MEDIAWIKI_DEB}
302 upload
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
303 tar cf
- ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
307 rm -f
*.5-opts.adoc
*.1-synopsis.adoc
*.8-synopsis.adoc
308 rm -f api-viewer
/apidata.js
309 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
313 rm -rf
*.html
*.pdf
*.epub
*.tmp
*.1 *.5 *.8 *.deb
*.changes build 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
314 find .
-name
'*~' -exec
rm {} ';'