3 include .
/pve-doc-generator.mk
5 GEN_PACKAGE
=pve-doc-generator
8 # also update debian/changelog
10 # also update doc-debian/changelog
13 GITVERSION
:=$(shell cat .git
/refs
/heads
/master
)
15 GEN_DEB
=${GEN_PACKAGE}_
${DOCRELEASE}-${GEN_PKGREL}_amd64.deb
16 DOC_DEB
=${DOC_PACKAGE}_
${DOCRELEASE}-${DOC_PKGREL}_all.deb
56 CONFIG_LIST
=datacenter.cfg qm.conf pct.conf
59 pve-doc-generator.mk \
61 $(addsuffix .adoc
, ${COMMAND_LIST}) \
62 $(addsuffix .adoc
, ${SERVICE_LIST}) \
63 $(addsuffix .adoc
, ${CONFIG_LIST}) \
64 pve-storage-dir.adoc \
65 pve-storage-glusterfs.adoc \
66 pve-storage-iscsi.adoc \
67 pve-storage-iscsidirect.adoc \
68 pve-storage-lvm.adoc \
69 pve-storage-nfs.adoc \
70 pve-storage-rbd.adoc \
71 pve-storage-zfspool.adoc \
77 gen-datacenter.cfg
.5-opts.pl \
78 gen-pct.conf
.5-opts.pl \
79 gen-qm.conf
.5-opts.pl \
80 gen-vzdump.conf
.5-opts.pl \
81 gen-pve-firewall-cluster-opts.pl \
82 gen-pve-firewall-host-opts.pl \
83 gen-pve-firewall-macros-adoc.pl \
84 gen-pve-firewall-rules-opts.pl \
85 gen-pve-firewall-vm-opts.pl
89 pve-package-repos.adoc \
90 pve-installation.adoc \
91 system-software-updates.adoc \
95 api-viewer
/index.html \
98 PVE_ADMIN_GUIDE_SOURCES
= \
99 ${DATACENTER_CONF_MAN5_SOURCES} \
100 ${QM_CONF_MAN5_SOURCES} \
101 ${PCT_CONF_MAN5_SOURCES} \
102 ${SYSADMIN_SOURCES} \
103 pve-admin-guide.adoc \
108 ${PVE_FIREWALL_MAN8_SOURCES} \
109 ${PVESM_MAN1_SOURCES} \
110 ${PCT_MAN1_SOURCES} \
111 ${PVECM_MAN1_SOURCES} \
112 ${PVEUM_MAN1_SOURCES} \
114 ${QMRESTORE_MAN1_SOURCES} \
115 ${HA_MANAGER_MAN1_SOURCES} \
116 ${PVESTATD_MAN8_SOURCES} \
117 ${PVEDAEMON_MAN8_SOURCES} \
118 ${PVEPROXY_MAN8_SOURCES} \
119 ${SPICEPROXY_MAN8_SOURCES} \
120 ${PVE_HA_CRM_MAN8_SOURCES} \
121 ${PVE_HA_LRM_MAN8_SOURCES} \
122 ${VZDUMP_MAN1_SOURCES} \
123 ${PVEAM_MAN1_SOURCES} \
124 ${PVESUBSCRIPTION_MAN1_SOURCES} \
125 ${PVECEPH_MAN1_SOURCES} \
126 pve-bibliography.adoc \
127 $(addsuffix .adoc
, ${COMMAND_LIST}) \
128 $(addsuffix .adoc
, ${SERVICE_LIST}) \
129 $(addsuffix .adoc
, ${CONFIG_LIST}) \
134 pve-admin-guide.pdf \
135 pve-admin-guide.html \
136 pve-admin-guide.epub \
137 $(addsuffix .1.html
, ${COMMAND_LIST}) \
138 $(addsuffix .8.html
, ${SERVICE_LIST}) \
139 $(addsuffix .5.html
, ${CONFIG_LIST}) \
140 $(addsuffix .html
, $(addprefix chapter-
, ${CHAPTER_LIST})) \
141 $(addsuffix -plain.html
, $(addprefix chapter-
, ${CHAPTER_LIST}))\
142 $(addsuffix .5-plain.html
, ${CONFIG_LIST})
144 ADOC_STDARG
= -a icons
-a data-uri
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}"
145 ADOC_MAN1_HTML_ARGS
=-a
"manvolnum=1" ${ADOC_STDARG}
146 ADOC_MAN5_HTML_ARGS
=-a
"manvolnum=5" ${ADOC_STDARG}
147 ADOC_MAN8_HTML_ARGS
=-a
"manvolnum=8" ${ADOC_STDARG}
153 %-nwdiag.svg
: %.nwdiag
154 nwdiag
-T svg
$*.nwdiag
-o
$@
;
156 chapter-
%.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
157 asciidoc
${ADOC_STDARG} -a toc
-o
$@
$*.adoc
159 chapter-
%-plain.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
160 asciidoc
-s
${ADOC_STDARG} -o chapter-
$*-plain.html
$*.adoc
162 %.1.html
: %.adoc
%.1-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
163 asciidoc
${ADOC_MAN1_HTML_ARGS} -o
$@
$*.adoc
165 pmxcfs
.8.html
: pmxcfs.adoc pmxcfs
.8-cli.adoc
${PVE_COMMON_DOC_SOURCES}
166 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@ pmxcfs.adoc
168 %.8.html
: %.adoc
%.8-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
169 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@
$*.adoc
171 %.5.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
172 asciidoc
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
174 %.5-plain.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
175 asciidoc
-s
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
179 $(BROWSER
) index.html
&
181 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
182 asciidoc
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}" index.adoc
184 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_SOURCES}
185 asciidoc
-a
"revnumber=${DOCRELEASE}" -a
"date=$(shell date)" pve-admin-guide.adoc
187 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_SOURCES}
188 rm -rf pve-admin-guide.chunked
189 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
191 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
192 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
193 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
195 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_SOURCES}
196 a2x
-f epub pve-admin-guide.adoc
198 api-viewer
/apidata.js
: extractapi.pl
201 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
202 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
205 dinstall
: ${GEN_DEB} ${DOC_DEB}
206 dpkg
-i
${GEN_DEB} ${DOC_DEB}
210 rm -f
${GEN_DEB} ${DOC_DEB};
214 ${DOC_DEB}: index.html
${INDEX_INCLUDES} ${API_VIEWER_SOURCES}
217 rsync
-a doc-debian
/ build
/debian
218 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
219 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
220 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/usr
/share
/doc
/${DOC_PACKAGE}/SOURCE
222 install -m
0644 ${INDEX_INCLUDES} build
/usr
/share
/${DOC_PACKAGE}
223 # install api doc viewer
224 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
225 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
226 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
229 ${GEN_DEB}: ${GEN_DEB_SOURCES}
232 rsync
-a debian
/ build
/debian
233 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
234 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
235 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/usr
/share
/doc
/${GEN_PACKAGE}/SOURCE
236 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
237 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
238 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
242 upload
: ${GEN_DEB} ${DOC_DEB}
243 umount
/pve
/${DOCRELEASE}; mount
/pve
/${DOCRELEASE} -o rw
244 mkdir
-p
/pve
/${DOCRELEASE}/extra
245 rm -f
/pve
/${DOCRELEASE}/extra
/${GEN_PACKAGE}_
*.deb
246 rm -f
/pve
/${DOCRELEASE}/extra
/${DOC_PACKAGE}_
*.deb
247 rm -f
/pve
/${DOCRELEASE}/extra
/Packages
*
248 cp
${GEN_DEB} ${DOC_DEB} /pve
/${DOCRELEASE}/extra
249 cd
/pve
/${DOCRELEASE}/extra
; dpkg-scanpackages .
/dev
/null
> Packages
; gzip
-9c Packages
> Packages.gz
250 umount
/pve
/${DOCRELEASE}; mount
/pve
/${DOCRELEASE} -o ro
254 rm -f
*.5-opts.adoc
*.1-synopsis.adoc
*.8-synopsis.adoc
255 rm -f api-viewer
/apidata.js
256 rm -f pve-firewall-macros.adoc
260 rm -rf
*.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
261 find .
-name
'*~' -exec
rm {} ';'