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