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
41 CONFIG_LIST
=datacenter.cfg qm.conf pct.conf
44 pve-doc-generator.mk \
46 $(addsuffix .adoc
, ${COMMAND_LIST}) \
47 $(addsuffix .adoc
, ${SERVICE_LIST}) \
48 $(addsuffix .adoc
, ${CONFIG_LIST}) \
49 pve-storage-dir.adoc \
50 pve-storage-glusterfs.adoc \
51 pve-storage-iscsi.adoc \
52 pve-storage-iscsidirect.adoc \
53 pve-storage-lvm.adoc \
54 pve-storage-nfs.adoc \
55 pve-storage-rbd.adoc \
56 pve-storage-zfspool.adoc \
62 gen-datacenter.cfg
.5-opts.pl \
63 gen-pct.conf
.5-opts.pl \
64 gen-qm.conf
.5-opts.pl \
65 gen-vzdump.conf
.5-opts.pl \
66 gen-pve-firewall-cluster-opts.pl \
67 gen-pve-firewall-host-opts.pl \
68 gen-pve-firewall-macros-adoc.pl \
69 gen-pve-firewall-rules-opts.pl \
70 gen-pve-firewall-vm-opts.pl
74 pve-package-repos.adoc \
75 pve-installation.adoc \
76 system-software-updates.adoc \
80 api-viewer
/index.html \
83 PVE_ADMIN_GUIDE_SOURCES
= \
84 ${DATACENTER_CONF_MAN5_SOURCES} \
85 ${QM_CONF_MAN5_SOURCES} \
86 ${PCT_CONF_MAN5_SOURCES} \
88 pve-admin-guide.adoc \
93 ${PVE_FIREWALL_MAN8_SOURCES} \
94 ${PVESM_MAN1_SOURCES} \
96 ${PVECM_MAN1_SOURCES} \
97 ${PVEUM_MAN1_SOURCES} \
99 ${QMRESTORE_MAN1_SOURCES} \
100 ${HA_MANAGER_MAN1_SOURCES} \
101 ${PVESTATD_MAN8_SOURCES} \
102 ${PVEDAEMON_MAN8_SOURCES} \
103 ${PVEPROXY_MAN8_SOURCES} \
104 ${SPICEPROXY_MAN8_SOURCES} \
105 ${PVE_HA_CRM_MAN8_SOURCES} \
106 ${PVE_HA_LRM_MAN8_SOURCES} \
107 ${VZDUMP_MAN1_SOURCES} \
108 ${PVEAM_MAN1_SOURCES} \
109 ${PVESUBSCRIPTION_MAN1_SOURCES} \
110 ${PVECEPH_MAN1_SOURCES} \
111 images
/cluster-nwdiag.svg \
112 images
/node-nwdiag.svg \
113 pve-bibliography.adoc \
114 $(addsuffix .adoc
, ${COMMAND_LIST}) \
115 $(addsuffix .adoc
, ${SERVICE_LIST}) \
116 $(addsuffix .adoc
, ${CONFIG_LIST}) \
120 ADOC_STDARG
= -a icons
-a data-uri
-a
"date=$(shell date)"
121 ADOC_MAN1_HTML_ARGS
=-a
"manvolnum=1" ${ADOC_STDARG} -a
"revnumber=${DOCRELEASE}"
122 ADOC_MAN5_HTML_ARGS
=-a
"manvolnum=5" ${ADOC_STDARG} -a
"revnumber=${DOCRELEASE}"
123 ADOC_MAN8_HTML_ARGS
=-a
"manvolnum=8" ${ADOC_STDARG} -a
"revnumber=${DOCRELEASE}"
127 all: pve-admin-guide.html
129 %-nwdiag.svg
: %.nwdiag
130 nwdiag
-T svg
$*.nwdiag
-o
$@
;
132 %.1.html
: %.adoc
%.1-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
133 asciidoc
${ADOC_MAN1_HTML_ARGS} -o
$@
$*.adoc
134 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
137 pmxcfs
.8.html
: pmxcfs.adoc pmxcfs
.8-cli.adoc
${PVE_COMMON_DOC_SOURCES}
138 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@ pmxcfs.adoc
139 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
141 %.8.html
: %.adoc
%.8-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
142 asciidoc
${ADOC_MAN8_HTML_ARGS} -o
$@
$*.adoc
143 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
145 %.5.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
146 asciidoc
${ADOC_MAN5_HTML_ARGS} -o
$@
$*.adoc
147 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
149 index.html
: index.adoc
${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
150 $(MAKE
) NOVIEW
=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
151 $(MAKE
) NOVIEW
=1 $(addsuffix .1.html
, ${COMMAND_LIST}) $(addsuffix .8.html
, ${SERVICE_LIST}) $(addsuffix .5.html
, ${CONFIG_LIST})
152 asciidoc
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}" index.adoc
153 test -n
"$${NOVIEW}" ||
$(BROWSER
) index.html
&
155 pve-admin-guide.html
: ${PVE_ADMIN_GUIDE_SOURCES}
156 asciidoc
-a
"revnumber=${DOCRELEASE}" -a
"date=$(shell date)" pve-admin-guide.adoc
157 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
159 pve-admin-guide.chunked
: ${PVE_ADMIN_GUIDE_SOURCES}
160 rm -rf pve-admin-guide.chunked
161 a2x
-a docinfo
-a docinfo1
-a icons
-f chunked pve-admin-guide.adoc
162 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
/index.html
&
164 pve-admin-guide.pdf
: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
165 grep
">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml ||
(echo
"wrong release in pve-admin-guide-docinfo.xml" && false
);
166 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
167 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
169 pve-admin-guide.epub
: ${PVE_ADMIN_GUIDE_SOURCES}
170 a2x
-f epub pve-admin-guide.adoc
171 test -n
"$${NOVIEW}" ||
$(BROWSER
) $@
&
173 api-viewer
/apidata.js
: extractapi.pl
176 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PVEAPI.js
177 cat api-viewer
/apidata.js api-viewer
/PVEAPI.js
>$@
180 dinstall
: ${GEN_DEB} ${DOC_DEB}
181 dpkg
-i
${GEN_DEB} ${DOC_DEB}
186 rm -f
${GEN_DEB} ${DOC_DEB};
191 $(addsuffix .1.html
, ${COMMAND_LIST}) \
192 $(addsuffix .8.html
, ${SERVICE_LIST}) \
193 $(addsuffix .5.html
, ${CONFIG_LIST}) \
194 pve-admin-guide.pdf \
195 pve-admin-guide.html \
196 pve-admin-guide.epub \
199 ${DOC_DEB}: index.adoc
${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
200 $(MAKE
) NOVIEW
=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
201 $(MAKE
) NOVIEW
=1 $(addsuffix .1.html
, ${COMMAND_LIST}) $(addsuffix .8.html
, ${SERVICE_LIST}) $(addsuffix .5.html
, ${CONFIG_LIST})
202 asciidoc
-a
"date=$(shell date)" -a
"revnumber=${DOCRELEASE}" index.adoc
205 rsync
-a doc-debian
/ build
/debian
206 mkdir
-p build
/usr
/share
/${DOC_PACKAGE}
207 mkdir
-p build
/usr
/share
/doc
/${DOC_PACKAGE}
208 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/usr
/share
/doc
/${DOC_PACKAGE}/SOURCE
210 install -m
0644 ${DOC_DEB_FILES} build
/usr
/share
/${DOC_PACKAGE}
211 # install api doc viewer
212 mkdir build
/usr
/share
/${DOC_PACKAGE}/api-viewer
213 install -m
0644 ${API_VIEWER_SOURCES} build
/usr
/share
/${DOC_PACKAGE}/api-viewer
214 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
217 ${GEN_DEB}: ${GEN_DEB_SOURCES}
220 rsync
-a debian
/ build
/debian
221 mkdir
-p build
/usr
/share
/${GEN_PACKAGE}
222 mkdir
-p build
/usr
/share
/doc
/${GEN_PACKAGE}
223 echo
"git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build
/usr
/share
/doc
/${GEN_PACKAGE}/SOURCE
224 install -m
0644 ${GEN_DEB_SOURCES} build
/usr
/share
/${GEN_PACKAGE}
225 install -m
0755 ${GEN_SCRIPTS} build
/usr
/share
/${GEN_PACKAGE}
226 cd build
; dpkg-buildpackage
-rfakeroot
-b
-us
-uc
230 upload
: ${GEN_DEB} ${DOC_DEB}
231 umount
/pve
/${DOCRELEASE}; mount
/pve
/${DOCRELEASE} -o rw
232 mkdir
-p
/pve
/${DOCRELEASE}/extra
233 rm -f
/pve
/${DOCRELEASE}/extra
/${GEN_PACKAGE}_
*.deb
234 rm -f
/pve
/${DOCRELEASE}/extra
/${DOC_PACKAGE}_
*.deb
235 rm -f
/pve
/${DOCRELEASE}/extra
/Packages
*
236 cp
${GEN_DEB} ${DOC_DEB} /pve
/${DOCRELEASE}/extra
237 cd
/pve
/${DOCRELEASE}/extra
; dpkg-scanpackages .
/dev
/null
> Packages
; gzip
-9c Packages
> Packages.gz
238 umount
/pve
/${DOCRELEASE}; mount
/pve
/${DOCRELEASE} -o ro
241 rm -f
*.5-opts.adoc
.1-synopsis.adoc
.8-synopsis.adoc
245 rm -rf
*.html
*.pdf
*.epub
*.tmp
*.1 *.5 *.8 *.deb
*.changes build api-viewer
/apidata.js api-viewer
/apidoc.js pve-admin-guide.chunked
246 find .
-name
'*~' -exec
rm {} ';'