]>
Commit | Line | Data |
---|---|---|
bef0c1b4 DM |
1 | DGDIR=. |
2 | ||
3 | include ./pve-doc-generator.mk | |
deb7f2ea | 4 | |
9344ee0d DM |
5 | PACKAGE=pve-doc-generator |
6 | ||
7 | # also update debian/changelog | |
8 | PKGREL=1 | |
9 | ||
b4f3c18a DM |
10 | GITVERSION:=$(shell cat .git/refs/heads/master) |
11 | ||
bef0c1b4 | 12 | DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb |
9344ee0d | 13 | |
672abac1 DM |
14 | COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager |
15 | ||
16 | SERVICE_LIST=pve-firewall pve-ha-crm pve-ha-lrm pvestatd | |
17 | ||
18 | CONFIG_LIST=datacenter.cfg qm.conf pct.conf | |
19 | ||
20 | DEB_SOURCES= \ | |
21 | pve-doc-generator.mk \ | |
22 | attributes.txt \ | |
23 | $(addsuffix .adoc, ${COMMAND_LIST}) \ | |
24 | $(addsuffix .adoc, ${SERVICE_LIST}) \ | |
25 | $(addsuffix .adoc, ${CONFIG_LIST}) \ | |
26 | pve-storage-dir.adoc \ | |
27 | pve-storage-glusterfs.adoc \ | |
28 | pve-storage-iscsi.adoc \ | |
29 | pve-storage-iscsidirect.adoc \ | |
30 | pve-storage-lvm.adoc \ | |
31 | pve-storage-nfs.adoc \ | |
32 | pve-storage-rbd.adoc \ | |
33 | pve-storage-zfspool.adoc \ | |
34 | pve-copyright.adoc \ | |
9344ee0d DM |
35 | docinfo.xml |
36 | ||
37 | GEN_SCRIPTS= \ | |
f6b81378 DM |
38 | gen-datacenter.cfg.5-opts.pl \ |
39 | gen-pct.conf.5-opts.pl \ | |
9b4799ab | 40 | gen-qm.conf.5-opts.pl \ |
9344ee0d DM |
41 | gen-pve-firewall-cluster-opts.pl \ |
42 | gen-pve-firewall-host-opts.pl \ | |
43 | gen-pve-firewall-macros-adoc.pl \ | |
44 | gen-pve-firewall-rules-opts.pl \ | |
f6b81378 | 45 | gen-pve-firewall-vm-opts.pl |
9344ee0d | 46 | |
deb7f2ea | 47 | VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc |
d61bab51 | 48 | PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc |
deb7f2ea | 49 | |
672abac1 DM |
50 | SYSADMIN_SOURCES= \ |
51 | getting-help.adoc \ | |
52 | pve-package-repos.adoc \ | |
53 | pve-installation.adoc \ | |
54 | system-software-updates.adoc \ | |
d91f8c1e DM |
55 | sysadmin.adoc |
56 | ||
672abac1 DM |
57 | PVE_ADMIN_GUIDE_SOURCES= \ |
58 | ${DATACENTER_CONF_MAN5_SOURCES} \ | |
59 | ${QM_CONF_MAN5_SOURCES} \ | |
60 | ${PCT_CONF_MAN5_SOURCES} \ | |
61 | ${SYSADMIN_SOURCES} \ | |
62 | pve-admin-guide.adoc \ | |
63 | pve-intro.adoc \ | |
64 | pmxcfs.adoc \ | |
65 | pve-faq.adoc \ | |
66 | ${PVE_FIREWALL_MAN8_SOURCES} \ | |
67 | ${PVESM_MAN1_SOURCES} \ | |
68 | ${PCT_MAN1_SOURCES} \ | |
69 | ${PVECM_MAN1_SOURCES} \ | |
70 | ${PVEUM_MAN1_SOURCES} \ | |
71 | ${QM_MAN1_SOURCES} \ | |
72 | ${QMRESTORE_MAN1_SOURCES} \ | |
73 | ${HA_MANAGER_MAN1_SOURCES} \ | |
74 | ${PVE_HA_CRM_MAN8_SOURCES} \ | |
75 | ${PVE_HA_LRM_MAN8_SOURCES} \ | |
76 | ${PVEAM_SOURCES} \ | |
77 | ${VZDUMP_SOURCES} \ | |
78 | images/cluster-nwdiag.svg \ | |
79 | images/node-nwdiag.svg \ | |
80 | pve-bibliography.adoc \ | |
81 | $(addsuffix .adoc, ${COMMAND_LIST}) \ | |
82 | $(addsuffix .adoc, ${SERVICE_LIST}) \ | |
83 | $(addsuffix .adoc, ${CONFIG_LIST}) \ | |
84 | GFDL.adoc \ | |
deb7f2ea DM |
85 | attributes.txt |
86 | ||
87 | ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" | |
bef0c1b4 DM |
88 | ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}" |
89 | ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}" | |
90 | ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}" | |
deb7f2ea | 91 | |
fc1090ef | 92 | BROWSER?=xdg-open |
df41beec | 93 | |
7b2c36ae DM |
94 | all: pve-admin-guide.html |
95 | ||
deb7f2ea DM |
96 | %-nwdiag.svg: %.nwdiag |
97 | nwdiag -T svg $*.nwdiag -o $@; | |
98 | ||
bef0c1b4 DM |
99 | %.1: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt |
100 | a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc | |
9344ee0d | 101 | test -n "$${NOVIEW}" || man -l $@ |
deb7f2ea | 102 | |
bef0c1b4 | 103 | %.1.html: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt |
deb7f2ea | 104 | asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc |
9344ee0d | 105 | test -n "$${NOVIEW}" || $(BROWSER) $@ & |
deb7f2ea DM |
106 | |
107 | ||
108 | %.8-synopsis.adoc: | |
109 | perl -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp | |
110 | mv $@.tmp $@ | |
111 | ||
112 | %.8: %.adoc %.8-synopsis.adoc docinfo.xml | |
bef0c1b4 | 113 | a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc |
9344ee0d | 114 | test -n "$${NOVIEW}" || man -l $@ |
deb7f2ea DM |
115 | |
116 | %.8.html: %.adoc %.8-synopsis.adoc docinfo.xml | |
117 | asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc | |
9344ee0d | 118 | test -n "$${NOVIEW}" || $(BROWSER) $@ & |
71e16346 | 119 | |
c016ebb7 DM |
120 | %.5.html: %.adoc %.5-opts.adoc docinfo.xml |
121 | asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc | |
9344ee0d | 122 | test -n "$${NOVIEW}" || $(BROWSER) $@ & |
c016ebb7 | 123 | |
deb7f2ea DM |
124 | index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} |
125 | $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub | |
672abac1 | 126 | $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST}) |
bef0c1b4 | 127 | asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc |
9344ee0d | 128 | test -n "$${NOVIEW}" || $(BROWSER) index.html & |
deb7f2ea DM |
129 | |
130 | pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES} | |
bef0c1b4 | 131 | asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc |
9344ee0d | 132 | test -n "$${NOVIEW}" || $(BROWSER) $@ & |
deb7f2ea | 133 | |
2296c490 | 134 | pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml |
bef0c1b4 | 135 | grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false); |
27125931 | 136 | 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 | 137 | test -n "$${NOVIEW}" || $(BROWSER) $@ & |
deb7f2ea DM |
138 | |
139 | pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES} | |
140 | a2x -f epub pve-admin-guide.adoc | |
9344ee0d DM |
141 | test -n "$${NOVIEW}" || $(BROWSER) $@ & |
142 | ||
143 | .PHONY: dinstall | |
144 | dinstall: ${DEB} | |
145 | dpkg -i ${DEB} | |
146 | ||
147 | .PHONY: deb | |
148 | ${DEB} deb: | |
149 | rm -rf build | |
150 | mkdir build | |
151 | rsync -a debian/ build/debian | |
152 | mkdir -p build/usr/share/${PACKAGE} | |
b4f3c18a DM |
153 | mkdir -p build/usr/share/doc/${PACKAGE} |
154 | echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${PACKAGE}/SOURCE | |
9344ee0d DM |
155 | install -m 0644 ${DEB_SOURCES} build/usr/share/${PACKAGE} |
156 | install -m 0755 ${GEN_SCRIPTS} build/usr/share/${PACKAGE} | |
157 | cd build; dpkg-buildpackage -rfakeroot -b -us -uc | |
158 | lintian ${DEB} | |
159 | ||
89e93b38 DM |
160 | .PHONY: upload |
161 | upload: ${DEB} | |
162 | umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw | |
163 | mkdir -p /pve/${DOCRELEASE}/extra | |
164 | rm -f /pve/${DOCRELEASE}/extra/${PACKAGE}_*.deb | |
165 | rm -f /pve/${DOCRELEASE}/extra/Packages* | |
166 | cp ${DEB} /pve/${DOCRELEASE}/extra | |
167 | cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz | |
168 | umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro | |
deb7f2ea | 169 | |
c016ebb7 DM |
170 | update: clean |
171 | rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc | |
172 | make all | |
deb7f2ea DM |
173 | |
174 | clean: | |
9344ee0d DM |
175 | rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build |
176 |