]>
Commit | Line | Data |
---|---|---|
bef0c1b4 | 1 | # also update debian/changelog |
05a63379 | 2 | DOCRELEASE=4.3 |
bef0c1b4 | 3 | |
9344ee0d DM |
4 | DGDIR?=/usr/share/pve-doc-generator |
5 | ||
f7b0e2cc | 6 | ASCIIDOC_PVE?=/usr/bin/asciidoc-pve |
c38115e9 | 7 | |
9344ee0d DM |
8 | all: |
9 | ||
828a27f5 DM |
10 | PVE_COMMON_DOC_SOURCES= \ |
11 | attributes.txt \ | |
12 | pve-copyright.adoc \ | |
13 | docinfo.xml | |
14 | ||
d8742b0c DM |
15 | PVECM_MAN1_SOURCES= \ |
16 | pvecm.adoc \ | |
17 | pvecm.1-synopsis.adoc \ | |
18 | ${PVE_COMMON_DOC_SOURCES} | |
19 | ||
9344ee0d DM |
20 | PVE_FIREWALL_MAN8_SOURCES= \ |
21 | pve-firewall.adoc \ | |
22 | pve-firewall.8-synopsis.adoc \ | |
23 | pve-firewall-cluster-opts.adoc \ | |
24 | pve-firewall-host-opts.adoc \ | |
25 | pve-firewall-vm-opts.adoc \ | |
26 | pve-firewall-rules-opts.adoc \ | |
27 | pve-firewall-macros.adoc \ | |
828a27f5 DM |
28 | ${PVE_COMMON_DOC_SOURCES} |
29 | ||
30 | PVESM_MAN1_SOURCES= \ | |
31 | pvesm.adoc \ | |
32 | pvesm.1-synopsis.adoc \ | |
33 | pve-storage-dir.adoc \ | |
34 | pve-storage-glusterfs.adoc \ | |
35 | pve-storage-iscsi.adoc \ | |
36 | pve-storage-iscsidirect.adoc \ | |
37 | pve-storage-lvm.adoc \ | |
82141a78 | 38 | pve-storage-lvmthin.adoc \ |
828a27f5 DM |
39 | pve-storage-nfs.adoc \ |
40 | pve-storage-rbd.adoc \ | |
41 | pve-storage-zfspool.adoc \ | |
42 | ${PVE_COMMON_DOC_SOURCES} | |
9344ee0d | 43 | |
6198e7c5 DM |
44 | VZDUMP_MAN1_SOURCES= \ |
45 | vzdump.adoc \ | |
46 | vzdump.1-synopsis.adoc \ | |
d083d3d3 | 47 | vzdump.conf.5-opts.adoc \ |
6198e7c5 DM |
48 | ${PVE_COMMON_DOC_SOURCES} |
49 | ||
ebd2a7fb DM |
50 | PVESUBSCRIPTION_MAN1_SOURCES= \ |
51 | pvesubscription.adoc \ | |
52 | pvesubscription.1-synopsis.adoc \ | |
53 | ${PVE_COMMON_DOC_SOURCES} | |
54 | ||
0840a663 DM |
55 | PVECEPH_MAN1_SOURCES= \ |
56 | pveceph.adoc \ | |
57 | pveceph.1-synopsis.adoc \ | |
58 | ${PVE_COMMON_DOC_SOURCES} | |
59 | ||
f6b81378 DM |
60 | PCT_MAN1_SOURCES= \ |
61 | pct.adoc \ | |
62 | pct.1-synopsis.adoc \ | |
d9da05c2 | 63 | pct.conf.5-opts.adoc \ |
bac8c385 | 64 | pct-network-opts.adoc \ |
fe154a4f | 65 | pct-mountpoint-opts.adoc \ |
f6b81378 DM |
66 | ${PVE_COMMON_DOC_SOURCES} |
67 | ||
672abac1 | 68 | PCT_CONF_MAN5_SOURCES= \ |
6ec3cd20 DM |
69 | pct.conf.adoc \ |
70 | pct.conf.5-opts.adoc \ | |
71 | ${PVE_COMMON_DOC_SOURCES} | |
72 | ||
672abac1 DM |
73 | DATACENTER_CONF_MAN5_SOURCES= \ |
74 | datacenter.cfg.adoc \ | |
75 | datacenter.cfg.5-opts.adoc \ | |
76 | ${PVE_COMMON_DOC_SOURCES} | |
77 | ||
7f8858a2 DM |
78 | QM_MAN1_SOURCES= \ |
79 | qm.adoc \ | |
80 | qm.1-synopsis.adoc \ | |
d9da05c2 | 81 | qm.conf.5-opts.adoc \ |
7f8858a2 DM |
82 | ${PVE_COMMON_DOC_SOURCES} |
83 | ||
672abac1 | 84 | QM_CONF_MAN5_SOURCES= \ |
6ec3cd20 DM |
85 | qm.conf.adoc \ |
86 | qm.conf.5-opts.adoc \ | |
87 | ${PVE_COMMON_DOC_SOURCES} | |
88 | ||
a5bb4c40 DM |
89 | QMRESTORE_MAN1_SOURCES= \ |
90 | qmrestore.adoc \ | |
91 | qmrestore.1-synopsis.adoc \ | |
92 | ${PVE_COMMON_DOC_SOURCES} | |
93 | ||
d7810cdb DM |
94 | PVEUM_MAN1_SOURCES= \ |
95 | pveum.adoc \ | |
96 | pveum.1-synopsis.adoc \ | |
97 | ${PVE_COMMON_DOC_SOURCES} | |
98 | ||
6198e7c5 DM |
99 | PVEAM_MAN1_SOURCES= \ |
100 | pveam.adoc \ | |
101 | pveam.1-synopsis.adoc \ | |
102 | ${PVE_COMMON_DOC_SOURCES} | |
103 | ||
104 | HA_MANAGER_MAN1_SOURCES= \ | |
105 | ha-manager.adoc \ | |
106 | ha-manager.1-synopsis.adoc \ | |
e26d2ff0 DM |
107 | ${PVE_COMMON_DOC_SOURCES} |
108 | ||
6198e7c5 DM |
109 | PVE_HA_CRM_MAN8_SOURCES= \ |
110 | pve-ha-crm.adoc \ | |
111 | pve-ha-crm.8-synopsis.adoc \ | |
47e1b0c6 DM |
112 | ${PVE_COMMON_DOC_SOURCES} |
113 | ||
6198e7c5 DM |
114 | PVE_HA_LRM_MAN8_SOURCES= \ |
115 | pve-ha-lrm.adoc \ | |
116 | pve-ha-lrm.8-synopsis.adoc \ | |
954a26fd DM |
117 | ${PVE_COMMON_DOC_SOURCES} |
118 | ||
4db6a3f3 DM |
119 | PVESTATD_MAN8_SOURCES= \ |
120 | pvestatd.adoc \ | |
121 | pvestatd.8-synopsis.adoc \ | |
122 | ${PVE_COMMON_DOC_SOURCES} | |
123 | ||
9ddb9dc3 DM |
124 | PVEDAEMON_MAN8_SOURCES= \ |
125 | pvedaemon.adoc \ | |
126 | pvedaemon.8-synopsis.adoc \ | |
127 | ${PVE_COMMON_DOC_SOURCES} | |
128 | ||
96f2beeb DM |
129 | PVEPROXY_MAN8_SOURCES= \ |
130 | pveproxy.adoc \ | |
131 | pveproxy.8-synopsis.adoc \ | |
132 | ${PVE_COMMON_DOC_SOURCES} | |
133 | ||
2d8f1c92 DM |
134 | SPICEPROXY_MAN8_SOURCES= \ |
135 | spiceproxy.adoc \ | |
136 | spiceproxy.8-synopsis.adoc \ | |
137 | ${PVE_COMMON_DOC_SOURCES} | |
138 | ||
bd88f9d9 DM |
139 | PMXCFS_MAN8_SOURCES= \ |
140 | pmxcfs.adoc \ | |
141 | pmxcfs.8-cli.adoc \ | |
142 | ${PVE_COMMON_DOC_SOURCES} | |
143 | ||
fcace69a FG |
144 | PVEPERF_MAN1_SOURCES= \ |
145 | pveperf.adoc \ | |
146 | pveperf.1-synopsis.adoc \ | |
147 | ${PVE_COMMON_DOC_SOURCES} | |
148 | ||
9344ee0d DM |
149 | attributes.txt docinfo.xml: |
150 | cp ${DGDIR}/$@ $@.tmp | |
151 | mv $@.tmp $@ | |
152 | ||
153 | %-opts.adoc: ${DGDIR}/gen-%-opts.pl | |
f6b81378 | 154 | ${DGDIR}/gen-$*-opts.pl >$@.tmp |
9344ee0d DM |
155 | mv $@.tmp $@ |
156 | ||
157 | %.adoc: ${DGDIR}/gen-%-adoc.pl | |
f6b81378 | 158 | ${DGDIR}/gen-$*-adoc.pl >$@.tmp |
9344ee0d DM |
159 | mv $@.tmp $@ |
160 | ||
fcace69a FG |
161 | pveperf.1-synopsis.adoc: |
162 | echo '*pveperf* `[PATH]`' > pveperf.1-synopsis.adoc | |
163 | ||
9344ee0d | 164 | %.1-synopsis.adoc: |
2fcf16df | 165 | perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp |
9344ee0d DM |
166 | mv $@.tmp $@ |
167 | ||
168 | %.8-synopsis.adoc: | |
2fcf16df | 169 | perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp |
9344ee0d DM |
170 | mv $@.tmp $@ |
171 | ||
f6b81378 | 172 | ifneq (${DGDIR},.) |
9344ee0d DM |
173 | %.adoc: ${DGDIR}/%.adoc |
174 | cp $< $@.tmp | |
175 | mv $@.tmp $@ | |
f6b81378 | 176 | endif |
9344ee0d | 177 | |
c38115e9 DM |
178 | pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES} ${ASCIIDOC_PVE} |
179 | ${ASCIIDOC_PVE} compile-man -o $@ pve-firewall.adoc | |
9344ee0d DM |
180 | test -n "$${NOVIEW}" || man -l $@ |
181 | ||
c38115e9 DM |
182 | pvesm.1: ${PVESM_MAN1_SOURCES} ${ASCIIDOC_PVE} |
183 | ${ASCIIDOC_PVE} compile-man -o $@ pvesm.adoc | |
828a27f5 DM |
184 | test -n "$${NOVIEW}" || man -l $@ |
185 | ||
c38115e9 DM |
186 | pveceph.1: ${PVECEPH_MAN1_SOURCES} ${ASCIIDOC_PVE} |
187 | ${ASCIIDOC_PVE} compile-man -o $@ pveceph.adoc | |
0840a663 DM |
188 | test -n "$${NOVIEW}" || man -l $@ |
189 | ||
c38115e9 DM |
190 | pct.1: ${PCT_MAN1_SOURCES} ${ASCIIDOC_PVE} |
191 | ${ASCIIDOC_PVE} compile-man -o $@ pct.adoc | |
f6b81378 DM |
192 | test -n "$${NOVIEW}" || man -l $@ |
193 | ||
c38115e9 DM |
194 | vzdump.1: ${VZDUMP_MAN1_SOURCES} ${ASCIIDOC_PVE} |
195 | ${ASCIIDOC_PVE} compile-man -o $@ vzdump.adoc | |
6198e7c5 DM |
196 | test -n "$${NOVIEW}" || man -l $@ |
197 | ||
c38115e9 DM |
198 | pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES} ${ASCIIDOC_PVE} |
199 | ${ASCIIDOC_PVE} compile-man -o $@ pvesubscription.adoc | |
ebd2a7fb DM |
200 | test -n "$${NOVIEW}" || man -l $@ |
201 | ||
c38115e9 DM |
202 | qm.1: ${QM_MAN1_SOURCES} ${ASCIIDOC_PVE} |
203 | ${ASCIIDOC_PVE} compile-man -o $@ qm.adoc | |
7f8858a2 DM |
204 | test -n "$${NOVIEW}" || man -l $@ |
205 | ||
c38115e9 DM |
206 | qmrestore.1: ${QMRESTORE_MAN1_SOURCES} ${ASCIIDOC_PVE} |
207 | ${ASCIIDOC_PVE} compile-man -o $@ qmrestore.adoc | |
a5bb4c40 DM |
208 | test -n "$${NOVIEW}" || man -l $@ |
209 | ||
c38115e9 DM |
210 | pvecm.1: ${PVECM_MAN1_SOURCES} ${ASCIIDOC_PVE} |
211 | ${ASCIIDOC_PVE} compile-man -o $@ pvecm.adoc | |
d8742b0c DM |
212 | test -n "$${NOVIEW}" || man -l $@ |
213 | ||
c38115e9 DM |
214 | pveum.1: ${PVEUM_MAN1_SOURCES} ${ASCIIDOC_PVE} |
215 | ${ASCIIDOC_PVE} compile-man -o $@ pveum.adoc | |
d7810cdb DM |
216 | test -n "$${NOVIEW}" || man -l $@ |
217 | ||
c38115e9 DM |
218 | pveam.1: ${PVEAM_MAN1_SOURCES} ${ASCIIDOC_PVE} |
219 | ${ASCIIDOC_PVE} compile-man -o $@ pveam.adoc | |
6198e7c5 DM |
220 | test -n "$${NOVIEW}" || man -l $@ |
221 | ||
c38115e9 DM |
222 | ha-manager.1: ${HA_MANAGER_MAN1_SOURCES} ${ASCIIDOC_PVE} |
223 | ${ASCIIDOC_PVE} compile-man -o $@ ha-manager.adoc | |
e26d2ff0 DM |
224 | test -n "$${NOVIEW}" || man -l $@ |
225 | ||
c38115e9 DM |
226 | pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES} ${ASCIIDOC_PVE} |
227 | ${ASCIIDOC_PVE} compile-man -o $@ pve-ha-crm.adoc | |
47e1b0c6 DM |
228 | test -n "$${NOVIEW}" || man -l $@ |
229 | ||
c38115e9 DM |
230 | pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES} ${ASCIIDOC_PVE} |
231 | ${ASCIIDOC_PVE} compile-man -o $@ pve-ha-lrm.adoc | |
954a26fd DM |
232 | test -n "$${NOVIEW}" || man -l $@ |
233 | ||
c38115e9 DM |
234 | pvestatd.8: ${PVESTATD_MAN8_SOURCES} ${ASCIIDOC_PVE} |
235 | ${ASCIIDOC_PVE} compile-man -o $@ pvestatd.adoc | |
4db6a3f3 DM |
236 | test -n "$${NOVIEW}" || man -l $@ |
237 | ||
c38115e9 DM |
238 | pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES} ${ASCIIDOC_PVE} |
239 | ${ASCIIDOC_PVE} compile-man -o $@ pvedaemon.adoc | |
9ddb9dc3 DM |
240 | test -n "$${NOVIEW}" || man -l $@ |
241 | ||
c38115e9 DM |
242 | pveproxy.8: ${PVEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE} |
243 | ${ASCIIDOC_PVE} compile-man -o $@ pveproxy.adoc | |
96f2beeb DM |
244 | test -n "$${NOVIEW}" || man -l $@ |
245 | ||
c38115e9 DM |
246 | spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE} |
247 | ${ASCIIDOC_PVE} compile-man -o $@ spiceproxy.adoc | |
2d8f1c92 DM |
248 | test -n "$${NOVIEW}" || man -l $@ |
249 | ||
c38115e9 DM |
250 | pmxcfs.8: ${PMXCFS_MAN8_SOURCES} ${ASCIIDOC_PVE} |
251 | ${ASCIIDOC_PVE} compile-man -o $@ pmxcfs.adoc | |
bd88f9d9 DM |
252 | test -n "$${NOVIEW}" || man -l $@ |
253 | ||
672abac1 DM |
254 | qm.conf.5: ${QM_CONF_MAN5_SOURCES} |
255 | ||
256 | pct.conf.5: ${PCT_CONF_MAN5_SOURCES} | |
6ec3cd20 | 257 | |
672abac1 | 258 | datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES} |
6ec3cd20 | 259 | |
c38115e9 DM |
260 | %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} ${ASCIIDOC_PVE} |
261 | ${ASCIIDOC_PVE} compile-man -o $@ $*.adoc | |
f6b81378 | 262 | test -n "$${NOVIEW}" || man -l $@ |
9344ee0d DM |
263 | |
264 | .PHONY: cleanup-docgen | |
265 | cleanup-docgen: | |
bca311e4 | 266 | rm -f *.tmp.xml *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml |