3 include .
/pve-doc-generator.mk
5 GEN_PACKAGE
=pve-doc-generator
7 MEDIAWIKI_PACKAGE
=pve-docs-mediawiki
9 # also update debian/changelog
12 GITVERSION
:=$(shell cat .git
/refs
/heads
/master
)
14 ARCH
:=$(shell dpkg-architecture
-qDEB_BUILD_ARCH
)
16 GEN_DEB
=${GEN_PACKAGE}_
${DOCRELEASE}-${PKGREL}_
${ARCH}.deb
17 DOC_DEB
=${DOC_PACKAGE}_
${DOCRELEASE}-${PKGREL}_all.deb
18 MEDIAWIKI_DEB
=${MEDIAWIKI_PACKAGE}_
${DOCRELEASE}-${PKGREL}_all.deb
69 CONFIG_LIST
=datacenter.cfg qm.conf pct.conf
72 pve-doc-generator.mk \
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 \
82 pve-storage-lvmthin.adoc \
83 pve-storage-nfs.adoc \
84 pve-storage-rbd.adoc \
85 pve-storage-zfspool.adoc \
91 gen-datacenter.cfg
.5-opts.pl \
92 gen-pct.conf
.5-opts.pl \
93 gen-pct-network-opts.pl \
94 gen-pct-mountpoint-opts.pl \
95 gen-qm.conf
.5-opts.pl \
96 gen-vzdump.conf
.5-opts.pl \
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 \
101 gen-pve-firewall-vm-opts.pl
103 INSTALLATION_SOURCES
= \
105 pve-system-requirements.adoc \
106 pve-installation.adoc
111 system-software-updates \
116 $(addsuffix .adoc
, ${SYSADMIN_PARTS}) \
119 API_VIEWER_SOURCES
= \
120 api-viewer
/index.html \
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 \
131 ${INSTALLATION_SOURCES} \
135 ${PVE_FIREWALL_MAN8_SOURCES} \
136 ${PVESM_MAN1_SOURCES} \
137 ${PCT_MAN1_SOURCES} \
138 ${PVECM_MAN1_SOURCES} \
139 ${PVEUM_MAN1_SOURCES} \
141 ${QMRESTORE_MAN1_SOURCES} \
142 ${HA_MANAGER_MAN1_SOURCES} \
143 ${PVESTATD_MAN8_SOURCES} \
144 ${PVEDAEMON_MAN8_SOURCES} \
145 ${PVEPROXY_MAN8_SOURCES} \
146 ${SPICEPROXY_MAN8_SOURCES} \
147 ${PVE_HA_CRM_MAN8_SOURCES} \
148 ${PVE_HA_LRM_MAN8_SOURCES} \
149 ${VZDUMP_MAN1_SOURCES} \
150 ${PVEAM_MAN1_SOURCES} \
151 ${PVESUBSCRIPTION_MAN1_SOURCES} \
152 ${PVECEPH_MAN1_SOURCES} \
153 pve-bibliography.adoc \
154 $(addsuffix .adoc
, ${COMMAND_LIST}) \
155 $(addsuffix .adoc
, ${SERVICE_LIST}) \
156 $(addsuffix .adoc
, ${CONFIG_LIST}) \
161 section-pve-usbstick-plain.html \
162 section-getting-help-plain.html \
163 section-pve-system-requirements-plain.html \
164 $(addsuffix -plain.html
, $(addprefix sysadmin-
, ${SYSADMIN_PARTS})) \
165 $(addsuffix -plain.html
, $(addprefix chapter-
, ${CHAPTER_LIST})) \
166 $(addsuffix .5-plain.html
, ${CONFIG_LIST}) \
167 $(addsuffix -plain.html
, $(addprefix pve-storage-
, ${STORAGE_TYPES}))
170 pve-admin-guide.pdf \
171 pve-admin-guide.html \
172 pve-admin-guide.epub \
173 $(addsuffix .1.html
, ${COMMAND_LIST}) \
174 $(addsuffix .8.html
, ${SERVICE_LIST}) \
175 $(addsuffix .5.html
, ${CONFIG_LIST}) \
176 $(addsuffix .html
, $(addprefix chapter-
, ${CHAPTER_LIST}))
178 ADOC_STDARG
= -a icons
-a data-uri
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}"
179 ADOC_MAN1_HTML_ARGS
=-a
"manvolnum=1" ${ADOC_STDARG}
180 ADOC_MAN5_HTML_ARGS
=-a
"manvolnum=5" ${ADOC_STDARG}
181 ADOC_MAN8_HTML_ARGS
=-a
"manvolnum=8" ${ADOC_STDARG}
187 %-nwdiag.svg
: %.nwdiag
188 nwdiag
-T svg
$*.nwdiag
-o
$@
;
190 sysadmin-
%-plain.html
: %.adoc
191 asciidoc
-s
-a wiki
-a
'leveloffset=-1' ${ADOC_STDARG} -o
$@
$*.adoc
193 section-
%-plain.html
: %.adoc
194 asciidoc
-s
-a wiki
-a
'leveloffset=-1' ${ADOC_STDARG} -o
$@
$*.adoc
196 chapter-sysadmin.html chapter-sysadmin-plain.html
: ${SYSADMIN_SOURCES}
198 chapter-
%.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
199 asciidoc
${ADOC_STDARG} -a toc
-o
$@
$*.adoc
201 chapter-
%-plain.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
202 asciidoc
-s
-a wiki
${ADOC_STDARG} -o
$@
$*.adoc
204 pve-storage-
%-plain.html
: pve-storage-
%.adoc
${PVE_COMMON_DOC_SOURCES}
205 asciidoc
-s
-a wiki
-a
'leveloffset=-1' ${ADOC_STDARG} -o
$@ pve-storage-
$*.adoc
207 %.1.html
: %.adoc
%.1-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
208 asciidoc
${ADOC_MAN1_HTML_ARGS} -o
$@
$*.adoc
210 pmxcfs
.8.html
: pmxcfs.adoc pmxcfs
.8-cli.adoc
${PVE_COMMON_DOC_SOURCES}
211 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@ pmxcfs.adoc
213 %.8.html
: %.adoc
%.8-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
214 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@
$*.adoc
216 %.5.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
217 asciidoc
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
219 %.5-plain.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
220 asciidoc
-s
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
222 README.html
: README.adoc
223 asciidoc
${ADOC_STDARG} -o
$@
$<
227 $(BROWSER
) index.html
&
229 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
230 asciidoc
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}" index.adoc
232 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_SOURCES}
233 asciidoc
-a pvelogo
-a
"revnumber=${DOCRELEASE}" -a
"date=$(shell date)" pve-admin-guide.adoc
235 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_SOURCES}
236 rm -rf pve-admin-guide.chunked
237 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
239 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
240 inkscape
-z
-D
--export-pdf
=proxmox-logo.pdf images
/proxmox-logo.svg
241 inkscape
-z
-D
--export-pdf
=proxmox-ci-header.pdf images
/proxmox-ci-header.svg
242 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
243 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
244 rm proxmox-logo.pdf proxmox-ci-header.pdf
246 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_SOURCES}
247 a2x
-f epub pve-admin-guide.adoc
249 api-viewer
/apidata.js
: extractapi.pl
252 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
253 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
256 dinstall
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
257 dpkg
-i
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
261 rm -f
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
262 make
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
264 ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html
${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES}
267 rsync
-a debian
/ build
/debian
268 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/debian
/SOURCE
269 # install files for pve-doc-generator package
270 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
271 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
272 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
273 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
274 # install files for pvedocs package
275 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
276 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
277 install -m
0644 index.html
${INDEX_INCLUDES} build
/usr
/share
/${DOC_PACKAGE}
278 install -m
0644 ${WIKI_IMPORTS} build
/usr
/share
/${DOC_PACKAGE}
279 # install api doc viewer
280 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
281 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
282 # build Debian packages
283 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
286 lintian
${MEDIAWIKI_DEB}
289 upload
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
290 tar cf
- ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
294 rm -f
*.5-opts.adoc
*.1-synopsis.adoc
*.8-synopsis.adoc
295 rm -f api-viewer
/apidata.js
296 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
300 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
301 find .
-name
'*~' -exec
rm {} ';'