]> git.proxmox.com Git - pve-docs.git/blame - Makefile
improve package dependencies, add README
[pve-docs.git] / Makefile
CommitLineData
bef0c1b4
DM
1DGDIR=.
2
3include ./pve-doc-generator.mk
deb7f2ea 4
9015f48f
DM
5GEN_PACKAGE=pve-doc-generator
6DOC_PACKAGE=pve-docs
9344ee0d
DM
7
8# also update debian/changelog
9PKGREL=1
10
b4f3c18a
DM
11GITVERSION:=$(shell cat .git/refs/heads/master)
12
9015f48f
DM
13GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
14DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
9344ee0d 15
ebd2a7fb
DM
16COMMAND_LIST= \
17 pvesubscription \
18 pvecm \
19 qm \
20 qmrestore \
0840a663 21 pveceph \
ebd2a7fb
DM
22 pct \
23 pveam \
24 pvesm \
25 pveum \
26 vzdump \
27 ha-manager
672abac1 28
96f2beeb
DM
29SERVICE_LIST= \
30 pve-firewall \
31 pve-ha-crm \
32 pve-ha-lrm \
33 pvestatd \
34 pmxcfs \
35 pveproxy \
2d8f1c92 36 spiceproxy \
96f2beeb 37 pvedaemon
672abac1
DM
38
39CONFIG_LIST=datacenter.cfg qm.conf pct.conf
40
9015f48f 41GEN_DEB_SOURCES= \
672abac1
DM
42 pve-doc-generator.mk \
43 attributes.txt \
44 $(addsuffix .adoc, ${COMMAND_LIST}) \
45 $(addsuffix .adoc, ${SERVICE_LIST}) \
46 $(addsuffix .adoc, ${CONFIG_LIST}) \
47 pve-storage-dir.adoc \
48 pve-storage-glusterfs.adoc \
49 pve-storage-iscsi.adoc \
50 pve-storage-iscsidirect.adoc \
51 pve-storage-lvm.adoc \
52 pve-storage-nfs.adoc \
53 pve-storage-rbd.adoc \
54 pve-storage-zfspool.adoc \
bd88f9d9 55 pmxcfs.8-cli.adoc \
672abac1 56 pve-copyright.adoc \
9344ee0d
DM
57 docinfo.xml
58
59GEN_SCRIPTS= \
f6b81378
DM
60 gen-datacenter.cfg.5-opts.pl \
61 gen-pct.conf.5-opts.pl \
9b4799ab 62 gen-qm.conf.5-opts.pl \
500f1e1f 63 gen-vzdump.conf.5-opts.pl \
9344ee0d
DM
64 gen-pve-firewall-cluster-opts.pl \
65 gen-pve-firewall-host-opts.pl \
66 gen-pve-firewall-macros-adoc.pl \
67 gen-pve-firewall-rules-opts.pl \
f6b81378 68 gen-pve-firewall-vm-opts.pl
9344ee0d 69
672abac1
DM
70SYSADMIN_SOURCES= \
71 getting-help.adoc \
72 pve-package-repos.adoc \
73 pve-installation.adoc \
74 system-software-updates.adoc \
d91f8c1e
DM
75 sysadmin.adoc
76
356064f4
DM
77API_VIEWER_SOURCES= \
78 api-viewer/index.html \
79 api-viewer/apidoc.js
80
672abac1
DM
81PVE_ADMIN_GUIDE_SOURCES= \
82 ${DATACENTER_CONF_MAN5_SOURCES} \
83 ${QM_CONF_MAN5_SOURCES} \
84 ${PCT_CONF_MAN5_SOURCES} \
85 ${SYSADMIN_SOURCES} \
86 pve-admin-guide.adoc \
87 pve-intro.adoc \
88 pmxcfs.adoc \
bd88f9d9 89 pmxcfs.8-cli.adoc \
672abac1
DM
90 pve-faq.adoc \
91 ${PVE_FIREWALL_MAN8_SOURCES} \
92 ${PVESM_MAN1_SOURCES} \
93 ${PCT_MAN1_SOURCES} \
94 ${PVECM_MAN1_SOURCES} \
95 ${PVEUM_MAN1_SOURCES} \
96 ${QM_MAN1_SOURCES} \
97 ${QMRESTORE_MAN1_SOURCES} \
98 ${HA_MANAGER_MAN1_SOURCES} \
2d8f1c92
DM
99 ${PVESTATD_MAN8_SOURCES} \
100 ${PVEDAEMON_MAN8_SOURCES} \
101 ${PVEPROXY_MAN8_SOURCES} \
102 ${SPICEPROXY_MAN8_SOURCES} \
672abac1
DM
103 ${PVE_HA_CRM_MAN8_SOURCES} \
104 ${PVE_HA_LRM_MAN8_SOURCES} \
6198e7c5
DM
105 ${VZDUMP_MAN1_SOURCES} \
106 ${PVEAM_MAN1_SOURCES} \
ebd2a7fb 107 ${PVESUBSCRIPTION_MAN1_SOURCES} \
0840a663 108 ${PVECEPH_MAN1_SOURCES} \
672abac1
DM
109 images/cluster-nwdiag.svg \
110 images/node-nwdiag.svg \
111 pve-bibliography.adoc \
112 $(addsuffix .adoc, ${COMMAND_LIST}) \
113 $(addsuffix .adoc, ${SERVICE_LIST}) \
114 $(addsuffix .adoc, ${CONFIG_LIST}) \
115 GFDL.adoc \
deb7f2ea
DM
116 attributes.txt
117
118ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)"
bef0c1b4
DM
119ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
120ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
121ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
deb7f2ea 122
fc1090ef 123BROWSER?=xdg-open
df41beec 124
7b2c36ae
DM
125all: pve-admin-guide.html
126
deb7f2ea
DM
127%-nwdiag.svg: %.nwdiag
128 nwdiag -T svg $*.nwdiag -o $@;
129
bd88f9d9 130%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea 131 asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
9344ee0d 132 test -n "$${NOVIEW}" || $(BROWSER) $@ &
deb7f2ea
DM
133
134
7c40c631
DM
135pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
136 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
137 test -n "$${NOVIEW}" || $(BROWSER) $@ &
deb7f2ea 138
7c40c631 139%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea 140 asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
9344ee0d 141 test -n "$${NOVIEW}" || $(BROWSER) $@ &
71e16346 142
7c40c631 143%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
c016ebb7 144 asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
9344ee0d 145 test -n "$${NOVIEW}" || $(BROWSER) $@ &
c016ebb7 146
356064f4 147index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
deb7f2ea 148 $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
672abac1 149 $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
bef0c1b4 150 asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
9344ee0d 151 test -n "$${NOVIEW}" || $(BROWSER) index.html &
deb7f2ea
DM
152
153pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
bef0c1b4 154 asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
9344ee0d 155 test -n "$${NOVIEW}" || $(BROWSER) $@ &
deb7f2ea 156
2296c490 157pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
bef0c1b4 158 grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
27125931 159 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
9344ee0d 160 test -n "$${NOVIEW}" || $(BROWSER) $@ &
deb7f2ea
DM
161
162pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
163 a2x -f epub pve-admin-guide.adoc
9344ee0d
DM
164 test -n "$${NOVIEW}" || $(BROWSER) $@ &
165
356064f4 166api-viewer/apidata.js: extractapi.pl
61568a65
DM
167 ./extractapi.pl >$@
168
356064f4
DM
169api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
170 cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
61568a65 171
9344ee0d 172.PHONY: dinstall
f8866417
DM
173dinstall: ${GEN_DEB} ${DOC_DEB}
174 dpkg -i ${GEN_DEB} ${DOC_DEB}
9015f48f 175
9344ee0d
DM
176
177.PHONY: deb
9015f48f
DM
178deb:
179 rm -f ${GEN_DEB} ${DOC_DEB};
180 make ${GEN_DEB};
181 make ${DOC_DEB};
182
183DOC_DEB_FILES= \
184 $(addsuffix .1.html, ${COMMAND_LIST}) \
185 $(addsuffix .8.html, ${SERVICE_LIST}) \
186 $(addsuffix .5.html, ${CONFIG_LIST}) \
187 pve-admin-guide.pdf \
188 pve-admin-guide.html \
189 pve-admin-guide.epub \
190 index.html
191
356064f4 192${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
9015f48f
DM
193 $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
194 $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
195 asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
196 rm -rf build
197 mkdir build
198 rsync -a doc-debian/ build/debian
199 mkdir -p build/usr/share/${DOC_PACKAGE}
200 mkdir -p build/usr/share/doc/${DOC_PACKAGE}
201 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${DOC_PACKAGE}/SOURCE
202 # install doc files
203 install -m 0644 ${DOC_DEB_FILES} build/usr/share/${DOC_PACKAGE}
61568a65 204 # install api doc viewer
356064f4
DM
205 mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
206 install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
9015f48f
DM
207 cd build; dpkg-buildpackage -rfakeroot -b -us -uc
208 lintian ${DOC_DEB}
209
210${GEN_DEB}: ${GEN_DEB_SOURCES}
9344ee0d
DM
211 rm -rf build
212 mkdir build
213 rsync -a debian/ build/debian
9015f48f
DM
214 mkdir -p build/usr/share/${GEN_PACKAGE}
215 mkdir -p build/usr/share/doc/${GEN_PACKAGE}
216 echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${GEN_PACKAGE}/SOURCE
217 install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
218 install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
9344ee0d 219 cd build; dpkg-buildpackage -rfakeroot -b -us -uc
9015f48f 220 lintian ${GEN_DEB}
9344ee0d 221
89e93b38 222.PHONY: upload
9015f48f 223upload: ${GEN_DEB} ${DOC_DEB}
89e93b38
DM
224 umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw
225 mkdir -p /pve/${DOCRELEASE}/extra
9015f48f
DM
226 rm -f /pve/${DOCRELEASE}/extra/${GEN_PACKAGE}_*.deb
227 rm -f /pve/${DOCRELEASE}/extra/${DOC_PACKAGE}_*.deb
89e93b38 228 rm -f /pve/${DOCRELEASE}/extra/Packages*
9015f48f 229 cp ${GEN_DEB} ${DOC_DEB} /pve/${DOCRELEASE}/extra
89e93b38
DM
230 cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz
231 umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro
deb7f2ea 232
c016ebb7
DM
233update: clean
234 rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
235 make all
deb7f2ea
DM
236
237clean:
356064f4 238 rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidata.js api-viewer/apidoc.js
9344ee0d 239