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
68 CONFIG_LIST
=datacenter.cfg qm.conf pct.conf
71 pve-doc-generator.mk \
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 \
89 gen-datacenter.cfg
.5-opts.pl \
90 gen-pct.conf
.5-opts.pl \
91 gen-pct-network-opts.pl \
92 gen-pct-mountpoint-opts.pl \
93 gen-qm.conf
.5-opts.pl \
94 gen-vzdump.conf
.5-opts.pl \
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 \
99 gen-pve-firewall-vm-opts.pl
106 system-software-updates \
111 $(addsuffix .adoc
, ${SYSADMIN_PARTS}) \
114 API_VIEWER_SOURCES
= \
115 api-viewer
/index.html \
118 PVE_ADMIN_GUIDE_SOURCES
= \
119 ${DATACENTER_CONF_MAN5_SOURCES} \
120 ${QM_CONF_MAN5_SOURCES} \
121 ${PCT_CONF_MAN5_SOURCES} \
122 ${SYSADMIN_SOURCES} \
123 pve-admin-guide.adoc \
128 ${PVE_FIREWALL_MAN8_SOURCES} \
129 ${PVESM_MAN1_SOURCES} \
130 ${PCT_MAN1_SOURCES} \
131 ${PVECM_MAN1_SOURCES} \
132 ${PVEUM_MAN1_SOURCES} \
134 ${QMRESTORE_MAN1_SOURCES} \
135 ${HA_MANAGER_MAN1_SOURCES} \
136 ${PVESTATD_MAN8_SOURCES} \
137 ${PVEDAEMON_MAN8_SOURCES} \
138 ${PVEPROXY_MAN8_SOURCES} \
139 ${SPICEPROXY_MAN8_SOURCES} \
140 ${PVE_HA_CRM_MAN8_SOURCES} \
141 ${PVE_HA_LRM_MAN8_SOURCES} \
142 ${VZDUMP_MAN1_SOURCES} \
143 ${PVEAM_MAN1_SOURCES} \
144 ${PVESUBSCRIPTION_MAN1_SOURCES} \
145 ${PVECEPH_MAN1_SOURCES} \
146 pve-bibliography.adoc \
147 $(addsuffix .adoc
, ${COMMAND_LIST}) \
148 $(addsuffix .adoc
, ${SERVICE_LIST}) \
149 $(addsuffix .adoc
, ${CONFIG_LIST}) \
154 $(addsuffix -plain.html
, $(addprefix sysadmin-
, ${SYSADMIN_PARTS})) \
155 $(addsuffix -plain.html
, $(addprefix chapter-
, ${CHAPTER_LIST})) \
156 $(addsuffix .5-plain.html
, ${CONFIG_LIST}) \
157 $(addsuffix -plain.html
, $(addprefix pve-storage-
, ${STORAGE_TYPES}))
160 pve-admin-guide.pdf \
161 pve-admin-guide.html \
162 pve-admin-guide.epub \
163 $(addsuffix .1.html
, ${COMMAND_LIST}) \
164 $(addsuffix .8.html
, ${SERVICE_LIST}) \
165 $(addsuffix .5.html
, ${CONFIG_LIST}) \
166 $(addsuffix .html
, $(addprefix chapter-
, ${CHAPTER_LIST}))
168 ADOC_STDARG
= -a icons
-a data-uri
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}"
169 ADOC_MAN1_HTML_ARGS
=-a
"manvolnum=1" ${ADOC_STDARG}
170 ADOC_MAN5_HTML_ARGS
=-a
"manvolnum=5" ${ADOC_STDARG}
171 ADOC_MAN8_HTML_ARGS
=-a
"manvolnum=8" ${ADOC_STDARG}
177 %-nwdiag.svg
: %.nwdiag
178 nwdiag
-T svg
$*.nwdiag
-o
$@
;
180 sysadmin-
%-plain.html
: %.adoc
181 asciidoc
-s
-a wiki
-a
'leveloffset=-1' ${ADOC_STDARG} -o
$@
$*.adoc
183 chapter-sysadmin.html chapter-sysadmin-plain.html
: ${SYSADMIN_SOURCES}
185 chapter-
%.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
186 asciidoc
${ADOC_STDARG} -a toc
-o
$@
$*.adoc
188 chapter-
%-plain.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
189 asciidoc
-s
-a wiki
${ADOC_STDARG} -o
$@
$*.adoc
191 pve-storage-
%-plain.html
: pve-storage-
%.adoc
${PVE_COMMON_DOC_SOURCES}
192 asciidoc
-s
-a wiki
-a
'leveloffset=-1' ${ADOC_STDARG} -o
$@ pve-storage-
$*.adoc
194 %.1.html
: %.adoc
%.1-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
195 asciidoc
${ADOC_MAN1_HTML_ARGS} -o
$@
$*.adoc
197 pmxcfs
.8.html
: pmxcfs.adoc pmxcfs
.8-cli.adoc
${PVE_COMMON_DOC_SOURCES}
198 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@ pmxcfs.adoc
200 %.8.html
: %.adoc
%.8-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
201 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@
$*.adoc
203 %.5.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
204 asciidoc
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
206 %.5-plain.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
207 asciidoc
-s
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
211 $(BROWSER
) index.html
&
213 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
214 asciidoc
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}" index.adoc
216 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_SOURCES}
217 asciidoc
-a
"revnumber=${DOCRELEASE}" -a
"date=$(shell date)" pve-admin-guide.adoc
219 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_SOURCES}
220 rm -rf pve-admin-guide.chunked
221 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
223 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
224 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
225 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
227 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_SOURCES}
228 a2x
-f epub pve-admin-guide.adoc
230 api-viewer
/apidata.js
: extractapi.pl
233 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
234 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
237 dinstall
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
238 dpkg
-i
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
242 rm -f
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
243 make
${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
245 ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html
${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES}
248 rsync
-a debian
/ build
/debian
249 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/debian
/SOURCE
250 # install files for pve-doc-generator package
251 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
252 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
253 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
254 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
255 # install files for pvedocs package
256 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
257 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
258 install -m
0644 index.html
${INDEX_INCLUDES} build
/usr
/share
/${DOC_PACKAGE}
259 install -m
0644 ${WIKI_IMPORTS} build
/usr
/share
/${DOC_PACKAGE}
260 # install api doc viewer
261 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
262 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
263 # build Debian packages
264 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
267 lintian
${MEDIAWIKI_DEB}
270 upload
: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
271 tar cf
- ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
275 rm -f
*.5-opts.adoc
*.1-synopsis.adoc
*.8-synopsis.adoc
276 rm -f api-viewer
/apidata.js
277 rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
281 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
282 find .
-name
'*~' -exec
rm {} ';'