1 # also update debian/changelog
4 DGDIR?
=/usr
/share
/pve-doc-generator
8 PVE_COMMON_DOC_SOURCES
= \
15 pvecm
.1-synopsis.adoc \
16 ${PVE_COMMON_DOC_SOURCES}
18 PVE_FIREWALL_MAN8_SOURCES
= \
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}
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}
41 VZDUMP_MAN1_SOURCES
= \
43 vzdump
.1-synopsis.adoc \
44 vzdump.conf
.5-opts.adoc \
45 ${PVE_COMMON_DOC_SOURCES}
47 PVESUBSCRIPTION_MAN1_SOURCES
= \
48 pvesubscription.adoc \
49 pvesubscription
.1-synopsis.adoc \
50 ${PVE_COMMON_DOC_SOURCES}
52 PVECEPH_MAN1_SOURCES
= \
54 pveceph
.1-synopsis.adoc \
55 ${PVE_COMMON_DOC_SOURCES}
60 pct-network-opts.adoc \
61 pct-mountpoint-opts.adoc \
62 ${PVE_COMMON_DOC_SOURCES}
64 PCT_CONF_MAN5_SOURCES
= \
66 pct.conf
.5-opts.adoc \
67 ${PVE_COMMON_DOC_SOURCES}
69 DATACENTER_CONF_MAN5_SOURCES
= \
71 datacenter.cfg
.5-opts.adoc \
72 ${PVE_COMMON_DOC_SOURCES}
77 ${PVE_COMMON_DOC_SOURCES}
79 QM_CONF_MAN5_SOURCES
= \
82 ${PVE_COMMON_DOC_SOURCES}
84 QMRESTORE_MAN1_SOURCES
= \
86 qmrestore
.1-synopsis.adoc \
87 ${PVE_COMMON_DOC_SOURCES}
91 pveum
.1-synopsis.adoc \
92 ${PVE_COMMON_DOC_SOURCES}
96 pveam
.1-synopsis.adoc \
97 ${PVE_COMMON_DOC_SOURCES}
99 HA_MANAGER_MAN1_SOURCES
= \
101 ha-manager
.1-synopsis.adoc \
102 ${PVE_COMMON_DOC_SOURCES}
104 PVE_HA_CRM_MAN8_SOURCES
= \
106 pve-ha-crm
.8-synopsis.adoc \
107 ${PVE_COMMON_DOC_SOURCES}
109 PVE_HA_LRM_MAN8_SOURCES
= \
111 pve-ha-lrm
.8-synopsis.adoc \
112 ${PVE_COMMON_DOC_SOURCES}
114 PVESTATD_MAN8_SOURCES
= \
116 pvestatd
.8-synopsis.adoc \
117 ${PVE_COMMON_DOC_SOURCES}
119 PVEDAEMON_MAN8_SOURCES
= \
121 pvedaemon
.8-synopsis.adoc \
122 ${PVE_COMMON_DOC_SOURCES}
124 PVEPROXY_MAN8_SOURCES
= \
126 pveproxy
.8-synopsis.adoc \
127 ${PVE_COMMON_DOC_SOURCES}
129 SPICEPROXY_MAN8_SOURCES
= \
131 spiceproxy
.8-synopsis.adoc \
132 ${PVE_COMMON_DOC_SOURCES}
134 PMXCFS_MAN8_SOURCES
= \
137 ${PVE_COMMON_DOC_SOURCES}
139 attributes.txt docinfo.xml
:
140 cp
${DGDIR}/$@
$@.tmp
143 %-opts.adoc
: ${DGDIR}/gen-
%-opts.pl
144 ${DGDIR}/gen-
$*-opts.pl
>$@.tmp
147 %.adoc
: ${DGDIR}/gen-
%-adoc.pl
148 ${DGDIR}/gen-
$*-adoc.pl
>$@.tmp
152 perl
-I.
-e
"use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
156 perl
-I.
-e
"use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
160 %.adoc
: ${DGDIR}/%.adoc
165 A2X_MAN_COMMON_OPTIONS
=-a docinfo1
-a
"manversion=Release ${DOCRELEASE}" -f manpage
166 A2X_MAN1_OPTIONS
=${A2X_MAN_COMMON_OPTIONS} -a
"manvolnum=1"
167 A2X_MAN5_OPTIONS
=${A2X_MAN_COMMON_OPTIONS} -a
"manvolnum=5"
168 A2X_MAN8_OPTIONS
=${A2X_MAN_COMMON_OPTIONS} -a
"manvolnum=8"
170 pve-firewall
.8: ${PVE_FIREWALL_MAN8_SOURCES}
171 a2x
${A2X_MAN8_OPTIONS} pve-firewall.adoc
172 test -n
"$${NOVIEW}" || man
-l
$@
174 pvesm
.1: ${PVESM_MAN1_SOURCES}
175 a2x
${A2X_MAN1_OPTIONS} pvesm.adoc
176 test -n
"$${NOVIEW}" || man
-l
$@
178 pveceph
.1: ${PVECEPH_MAN1_SOURCES}
179 a2x
${A2X_MAN1_OPTIONS} pveceph.adoc
180 test -n
"$${NOVIEW}" || man
-l
$@
182 pct
.1: ${PCT_MAN1_SOURCES}
183 a2x
${A2X_MAN1_OPTIONS} pct.adoc
184 test -n
"$${NOVIEW}" || man
-l
$@
186 vzdump
.1: ${VZDUMP_MAN1_SOURCES}
187 a2x
${A2X_MAN1_OPTIONS} vzdump.adoc
188 test -n
"$${NOVIEW}" || man
-l
$@
190 pvesubscription
.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
191 a2x
${A2X_MAN1_OPTIONS} pvesubscription.adoc
192 test -n
"$${NOVIEW}" || man
-l
$@
194 qm
.1: ${QM_MAN1_SOURCES}
195 a2x
${A2X_MAN1_OPTIONS} qm.adoc
196 test -n
"$${NOVIEW}" || man
-l
$@
198 qmrestore
.1: ${QMRESTORE_MAN1_SOURCES}
199 a2x
${A2X_MAN1_OPTIONS} qmrestore.adoc
200 test -n
"$${NOVIEW}" || man
-l
$@
202 pvecm
.1: ${PVECM_MAN1_SOURCES}
203 a2x
${A2X_MAN1_OPTIONS} pvecm.adoc
204 test -n
"$${NOVIEW}" || man
-l
$@
206 pveum
.1: ${PVEUM_MAN1_SOURCES}
207 a2x
${A2X_MAN1_OPTIONS} pveum.adoc
208 test -n
"$${NOVIEW}" || man
-l
$@
210 pveam
.1: ${PVEAM_MAN1_SOURCES}
211 a2x
${A2X_MAN1_OPTIONS} pveam.adoc
212 test -n
"$${NOVIEW}" || man
-l
$@
214 ha-manager
.1: ${HA_MANAGER_MAN1_SOURCES}
215 a2x
${A2X_MAN1_OPTIONS} ha-manager.adoc
216 test -n
"$${NOVIEW}" || man
-l
$@
218 pve-ha-crm
.8: ${PVE_HA_CRM_MAN8_SOURCES}
219 a2x
${A2X_MAN8_OPTIONS} pve-ha-crm.adoc
220 test -n
"$${NOVIEW}" || man
-l
$@
222 pve-ha-lrm
.8: ${PVE_HA_LRM_MAN8_SOURCES}
223 a2x
${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
224 test -n
"$${NOVIEW}" || man
-l
$@
226 pvestatd
.8: ${PVESTATD_MAN8_SOURCES}
227 a2x
${A2X_MAN8_OPTIONS} pvestatd.adoc
228 test -n
"$${NOVIEW}" || man
-l
$@
230 pvedaemon
.8: ${PVEDAEMON_MAN8_SOURCES}
231 a2x
${A2X_MAN8_OPTIONS} pvedaemon.adoc
232 test -n
"$${NOVIEW}" || man
-l
$@
234 pveproxy
.8: ${PVEPROXY_MAN8_SOURCES}
235 a2x
${A2X_MAN8_OPTIONS} pveproxy.adoc
236 test -n
"$${NOVIEW}" || man
-l
$@
238 spiceproxy
.8: ${SPICEPROXY_MAN8_SOURCES}
239 a2x
${A2X_MAN8_OPTIONS} spiceproxy.adoc
240 test -n
"$${NOVIEW}" || man
-l
$@
242 pmxcfs
.8: ${PMXCFS_MAN8_SOURCES}
243 a2x
${A2X_MAN8_OPTIONS} pmxcfs.adoc
244 test -n
"$${NOVIEW}" || man
-l
$@
246 qm.conf
.5: ${QM_CONF_MAN5_SOURCES}
248 pct.conf
.5: ${PCT_CONF_MAN5_SOURCES}
250 datacenter.cfg
.5: ${DATACENTER_CONF_MAN5_SOURCES}
252 %.5: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
253 a2x
${A2X_MAN5_OPTIONS} $*.adoc
254 test -n
"$${NOVIEW}" || man
-l
$@
256 .PHONY
: cleanup-docgen
258 rm -f
*.1 *.5 *.8 *.adoc attributes.txt docinfo.xml