]>
Commit | Line | Data |
---|---|---|
1 | DGDIR=. | |
2 | ||
3 | include ./pve-doc-generator.mk | |
4 | ||
5 | GEN_PACKAGE=pve-doc-generator | |
6 | DOC_PACKAGE=pve-docs | |
7 | ||
8 | # also update debian/changelog | |
9 | GEN_PKGREL=1 | |
10 | # also update doc-debian/changelog | |
11 | DOC_PKGREL=2 | |
12 | ||
13 | GITVERSION:=$(shell cat .git/refs/heads/master) | |
14 | ||
15 | GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${GEN_PKGREL}_amd64.deb | |
16 | DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${DOC_PKGREL}_all.deb | |
17 | ||
18 | CHAPTER_LIST= \ | |
19 | sysadmin \ | |
20 | pvecm \ | |
21 | pmxcfs \ | |
22 | pvesm \ | |
23 | qm \ | |
24 | pve-firewall \ | |
25 | pveum \ | |
26 | pct \ | |
27 | ha-manager \ | |
28 | vzdump \ | |
29 | pve-faq \ | |
30 | pve-bibliography | |
31 | ||
32 | STORAGE_TYPES= \ | |
33 | dir \ | |
34 | glusterfs \ | |
35 | iscsi \ | |
36 | iscsidirect \ | |
37 | lvm \ | |
38 | lvmthin \ | |
39 | nfs \ | |
40 | rbd \ | |
41 | zfspool | |
42 | ||
43 | COMMAND_LIST= \ | |
44 | pvesubscription \ | |
45 | pvecm \ | |
46 | qm \ | |
47 | qmrestore \ | |
48 | pveceph \ | |
49 | pct \ | |
50 | pveam \ | |
51 | pvesm \ | |
52 | pveum \ | |
53 | vzdump \ | |
54 | ha-manager | |
55 | ||
56 | SERVICE_LIST= \ | |
57 | pve-firewall \ | |
58 | pve-ha-crm \ | |
59 | pve-ha-lrm \ | |
60 | pvestatd \ | |
61 | pmxcfs \ | |
62 | pveproxy \ | |
63 | spiceproxy \ | |
64 | pvedaemon | |
65 | ||
66 | CONFIG_LIST=datacenter.cfg qm.conf pct.conf | |
67 | ||
68 | GEN_DEB_SOURCES= \ | |
69 | pve-doc-generator.mk \ | |
70 | attributes.txt \ | |
71 | $(addsuffix .adoc, ${COMMAND_LIST}) \ | |
72 | $(addsuffix .adoc, ${SERVICE_LIST}) \ | |
73 | $(addsuffix .adoc, ${CONFIG_LIST}) \ | |
74 | pve-storage-dir.adoc \ | |
75 | pve-storage-glusterfs.adoc \ | |
76 | pve-storage-iscsi.adoc \ | |
77 | pve-storage-iscsidirect.adoc \ | |
78 | pve-storage-lvm.adoc \ | |
79 | pve-storage-nfs.adoc \ | |
80 | pve-storage-rbd.adoc \ | |
81 | pve-storage-zfspool.adoc \ | |
82 | pmxcfs.8-cli.adoc \ | |
83 | pve-copyright.adoc \ | |
84 | docinfo.xml | |
85 | ||
86 | GEN_SCRIPTS= \ | |
87 | gen-datacenter.cfg.5-opts.pl \ | |
88 | gen-pct.conf.5-opts.pl \ | |
89 | gen-pct-network-opts.pl \ | |
90 | gen-qm.conf.5-opts.pl \ | |
91 | gen-vzdump.conf.5-opts.pl \ | |
92 | gen-pve-firewall-cluster-opts.pl \ | |
93 | gen-pve-firewall-host-opts.pl \ | |
94 | gen-pve-firewall-macros-adoc.pl \ | |
95 | gen-pve-firewall-rules-opts.pl \ | |
96 | gen-pve-firewall-vm-opts.pl | |
97 | ||
98 | SYSADMIN_SOURCES= \ | |
99 | getting-help.adoc \ | |
100 | pve-package-repos.adoc \ | |
101 | pve-installation.adoc \ | |
102 | system-software-updates.adoc \ | |
103 | sysadmin.adoc | |
104 | ||
105 | API_VIEWER_SOURCES= \ | |
106 | api-viewer/index.html \ | |
107 | api-viewer/apidoc.js | |
108 | ||
109 | PVE_ADMIN_GUIDE_SOURCES= \ | |
110 | ${DATACENTER_CONF_MAN5_SOURCES} \ | |
111 | ${QM_CONF_MAN5_SOURCES} \ | |
112 | ${PCT_CONF_MAN5_SOURCES} \ | |
113 | ${SYSADMIN_SOURCES} \ | |
114 | pve-admin-guide.adoc \ | |
115 | pve-intro.adoc \ | |
116 | pmxcfs.adoc \ | |
117 | pmxcfs.8-cli.adoc \ | |
118 | pve-faq.adoc \ | |
119 | ${PVE_FIREWALL_MAN8_SOURCES} \ | |
120 | ${PVESM_MAN1_SOURCES} \ | |
121 | ${PCT_MAN1_SOURCES} \ | |
122 | ${PVECM_MAN1_SOURCES} \ | |
123 | ${PVEUM_MAN1_SOURCES} \ | |
124 | ${QM_MAN1_SOURCES} \ | |
125 | ${QMRESTORE_MAN1_SOURCES} \ | |
126 | ${HA_MANAGER_MAN1_SOURCES} \ | |
127 | ${PVESTATD_MAN8_SOURCES} \ | |
128 | ${PVEDAEMON_MAN8_SOURCES} \ | |
129 | ${PVEPROXY_MAN8_SOURCES} \ | |
130 | ${SPICEPROXY_MAN8_SOURCES} \ | |
131 | ${PVE_HA_CRM_MAN8_SOURCES} \ | |
132 | ${PVE_HA_LRM_MAN8_SOURCES} \ | |
133 | ${VZDUMP_MAN1_SOURCES} \ | |
134 | ${PVEAM_MAN1_SOURCES} \ | |
135 | ${PVESUBSCRIPTION_MAN1_SOURCES} \ | |
136 | ${PVECEPH_MAN1_SOURCES} \ | |
137 | pve-bibliography.adoc \ | |
138 | $(addsuffix .adoc, ${COMMAND_LIST}) \ | |
139 | $(addsuffix .adoc, ${SERVICE_LIST}) \ | |
140 | $(addsuffix .adoc, ${CONFIG_LIST}) \ | |
141 | GFDL.adoc \ | |
142 | attributes.txt | |
143 | ||
144 | WIKI_IMPORTS= \ | |
145 | $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST}))\ | |
146 | $(addsuffix .5-plain.html, ${CONFIG_LIST}) \ | |
147 | $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES})) | |
148 | ||
149 | INDEX_INCLUDES= \ | |
150 | pve-admin-guide.pdf \ | |
151 | pve-admin-guide.html \ | |
152 | pve-admin-guide.epub \ | |
153 | $(addsuffix .1.html, ${COMMAND_LIST}) \ | |
154 | $(addsuffix .8.html, ${SERVICE_LIST}) \ | |
155 | $(addsuffix .5.html, ${CONFIG_LIST}) \ | |
156 | $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST})) | |
157 | ||
158 | ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" | |
159 | ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} | |
160 | ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} | |
161 | ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} | |
162 | ||
163 | BROWSER?=xdg-open | |
164 | ||
165 | all: index.html | |
166 | ||
167 | %-nwdiag.svg: %.nwdiag | |
168 | nwdiag -T svg $*.nwdiag -o $@; | |
169 | ||
170 | chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES} | |
171 | asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc | |
172 | ||
173 | chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES} | |
174 | asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc | |
175 | ||
176 | pve-storage-%-plain.html: pve-storage-%.adoc ${PVE_COMMON_DOC_SOURCES} | |
177 | asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ pve-storage-$*.adoc | |
178 | ||
179 | %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} | |
180 | asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc | |
181 | ||
182 | pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES} | |
183 | asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc | |
184 | ||
185 | %.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} | |
186 | asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc | |
187 | ||
188 | %.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} | |
189 | asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc | |
190 | ||
191 | %.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} | |
192 | asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc | |
193 | ||
194 | .PHONY: index | |
195 | index: index.html | |
196 | $(BROWSER) index.html & | |
197 | ||
198 | index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} | |
199 | asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc | |
200 | ||
201 | pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES} | |
202 | asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc | |
203 | ||
204 | pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES} | |
205 | rm -rf pve-admin-guide.chunked | |
206 | a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc | |
207 | ||
208 | pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml | |
209 | grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false); | |
210 | 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 | |
211 | ||
212 | pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES} | |
213 | a2x -f epub pve-admin-guide.adoc | |
214 | ||
215 | api-viewer/apidata.js: extractapi.pl | |
216 | ./extractapi.pl >$@ | |
217 | ||
218 | api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js | |
219 | cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@ | |
220 | ||
221 | .PHONY: dinstall | |
222 | dinstall: ${GEN_DEB} ${DOC_DEB} | |
223 | dpkg -i ${GEN_DEB} ${DOC_DEB} | |
224 | ||
225 | .PHONY: deb | |
226 | deb: | |
227 | rm -f ${GEN_DEB} ${DOC_DEB}; | |
228 | make ${GEN_DEB}; | |
229 | make ${DOC_DEB}; | |
230 | ||
231 | ${DOC_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} | |
232 | rm -rf build | |
233 | mkdir build | |
234 | rsync -a doc-debian/ build/debian | |
235 | mkdir -p build/usr/share/${DOC_PACKAGE} | |
236 | mkdir -p build/usr/share/doc/${DOC_PACKAGE} | |
237 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${DOC_PACKAGE}/SOURCE | |
238 | # install doc files | |
239 | install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE} | |
240 | install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE} | |
241 | # install api doc viewer | |
242 | mkdir build/usr/share/${DOC_PACKAGE}/api-viewer | |
243 | install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer | |
244 | cd build; dpkg-buildpackage -rfakeroot -b -us -uc | |
245 | lintian ${DOC_DEB} | |
246 | ||
247 | ${GEN_DEB}: ${GEN_DEB_SOURCES} | |
248 | rm -rf build | |
249 | mkdir build | |
250 | rsync -a debian/ build/debian | |
251 | mkdir -p build/usr/share/${GEN_PACKAGE} | |
252 | mkdir -p build/usr/share/doc/${GEN_PACKAGE} | |
253 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${GEN_PACKAGE}/SOURCE | |
254 | install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE} | |
255 | install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE} | |
256 | cd build; dpkg-buildpackage -rfakeroot -b -us -uc | |
257 | lintian ${GEN_DEB} | |
258 | ||
259 | .PHONY: upload | |
260 | upload: ${GEN_DEB} ${DOC_DEB} | |
261 | umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw | |
262 | mkdir -p /pve/${DOCRELEASE}/extra | |
263 | rm -f /pve/${DOCRELEASE}/extra/${GEN_PACKAGE}_*.deb | |
264 | rm -f /pve/${DOCRELEASE}/extra/${DOC_PACKAGE}_*.deb | |
265 | rm -f /pve/${DOCRELEASE}/extra/Packages* | |
266 | cp ${GEN_DEB} ${DOC_DEB} /pve/${DOCRELEASE}/extra | |
267 | cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz | |
268 | umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro | |
269 | ||
270 | .PHONY: update | |
271 | update: clean | |
272 | rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc | |
273 | rm -f api-viewer/apidata.js | |
274 | rm -f pve-firewall-macros.adoc pct-network-opts.adoc | |
275 | make all | |
276 | ||
277 | clean: | |
278 | 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 | |
279 | find . -name '*~' -exec rm {} ';' |