fix *.conf.5 dependencies
[pve-docs.git] / pve-doc-generator.mk
CommitLineData
bef0c1b4
DM
1# also update debian/changelog
2DOCRELEASE=4.1
3
9344ee0d
DM
4DGDIR?=/usr/share/pve-doc-generator
5
6all:
7
828a27f5
DM
8PVE_COMMON_DOC_SOURCES= \
9 attributes.txt \
10 pve-copyright.adoc \
11 docinfo.xml
12
d8742b0c
DM
13PVECM_MAN1_SOURCES= \
14 pvecm.adoc \
15 pvecm.1-synopsis.adoc \
16 ${PVE_COMMON_DOC_SOURCES}
17
9344ee0d
DM
18PVE_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 \
828a27f5
DM
26 ${PVE_COMMON_DOC_SOURCES}
27
28PVESM_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}
9344ee0d 40
f6b81378
DM
41PCT_MAN1_SOURCES= \
42 pct.adoc \
43 pct.1-synopsis.adoc \
44 ${PVE_COMMON_DOC_SOURCES}
45
6ec3cd20
DM
46PCT_CONF_MAN5_SOURCE= \
47 pct.conf.adoc \
48 pct.conf.5-opts.adoc \
49 ${PVE_COMMON_DOC_SOURCES}
50
7f8858a2
DM
51QM_MAN1_SOURCES= \
52 qm.adoc \
53 qm.1-synopsis.adoc \
54 ${PVE_COMMON_DOC_SOURCES}
55
6ec3cd20
DM
56QM_CONF_MAN5_SOURCE= \
57 qm.conf.adoc \
58 qm.conf.5-opts.adoc \
59 ${PVE_COMMON_DOC_SOURCES}
60
a5bb4c40
DM
61QMRESTORE_MAN1_SOURCES= \
62 qmrestore.adoc \
63 qmrestore.1-synopsis.adoc \
64 ${PVE_COMMON_DOC_SOURCES}
65
d7810cdb
DM
66PVEUM_MAN1_SOURCES= \
67 pveum.adoc \
68 pveum.1-synopsis.adoc \
69 ${PVE_COMMON_DOC_SOURCES}
70
e26d2ff0
DM
71HA_MANAGER_MAN1_SOURCES= \
72 ha-manager.adoc \
73 ha-manager.1-synopsis.adoc \
74 ${PVE_COMMON_DOC_SOURCES}
75
47e1b0c6
DM
76PVE_HA_CRM_MAN8_SOURCES= \
77 pve-ha-crm.adoc \
78 pve-ha-crm.8-synopsis.adoc \
79 ${PVE_COMMON_DOC_SOURCES}
80
954a26fd
DM
81PVE_HA_LRM_MAN8_SOURCES= \
82 pve-ha-lrm.adoc \
83 pve-ha-lrm.8-synopsis.adoc \
84 ${PVE_COMMON_DOC_SOURCES}
85
9344ee0d
DM
86attributes.txt docinfo.xml:
87 cp ${DGDIR}/$@ $@.tmp
88 mv $@.tmp $@
89
90%-opts.adoc: ${DGDIR}/gen-%-opts.pl
f6b81378 91 ${DGDIR}/gen-$*-opts.pl >$@.tmp
9344ee0d
DM
92 mv $@.tmp $@
93
94%.adoc: ${DGDIR}/gen-%-adoc.pl
f6b81378 95 ${DGDIR}/gen-$*-adoc.pl >$@.tmp
9344ee0d
DM
96 mv $@.tmp $@
97
98%.1-synopsis.adoc:
99 perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
100 mv $@.tmp $@
101
102%.8-synopsis.adoc:
103 perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
104 mv $@.tmp $@
105
f6b81378 106ifneq (${DGDIR},.)
9344ee0d
DM
107%.adoc: ${DGDIR}/%.adoc
108 cp $< $@.tmp
109 mv $@.tmp $@
f6b81378 110endif
9344ee0d 111
872bbc1b
DM
112A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
113A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
114A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
115A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
116
9344ee0d 117pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
872bbc1b 118 a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
9344ee0d
DM
119 test -n "$${NOVIEW}" || man -l $@
120
828a27f5 121pvesm.1: ${PVESM_MAN1_SOURCES}
872bbc1b 122 a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
828a27f5
DM
123 test -n "$${NOVIEW}" || man -l $@
124
f6b81378 125pct.1: ${PCT_MAN1_SOURCES}
872bbc1b 126 a2x ${A2X_MAN1_OPTIONS} pct.adoc
f6b81378
DM
127 test -n "$${NOVIEW}" || man -l $@
128
7f8858a2 129qm.1: ${QM_MAN1_SOURCES}
872bbc1b 130 a2x ${A2X_MAN1_OPTIONS} qm.adoc
7f8858a2
DM
131 test -n "$${NOVIEW}" || man -l $@
132
a5bb4c40 133qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
872bbc1b 134 a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
a5bb4c40
DM
135 test -n "$${NOVIEW}" || man -l $@
136
d8742b0c 137pvecm.1: ${PVECM_MAN1_SOURCES}
872bbc1b 138 a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
d8742b0c
DM
139 test -n "$${NOVIEW}" || man -l $@
140
d7810cdb 141pveum.1: ${PVEUM_MAN1_SOURCES}
872bbc1b 142 a2x ${A2X_MAN1_OPTIONS} pveum.adoc
d7810cdb
DM
143 test -n "$${NOVIEW}" || man -l $@
144
e26d2ff0 145ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
872bbc1b 146 a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
e26d2ff0
DM
147 test -n "$${NOVIEW}" || man -l $@
148
47e1b0c6 149pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
872bbc1b 150 a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
47e1b0c6
DM
151 test -n "$${NOVIEW}" || man -l $@
152
954a26fd 153pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
872bbc1b 154 a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
954a26fd
DM
155 test -n "$${NOVIEW}" || man -l $@
156
6ec3cd20
DM
157qm.conf.5: ${QM_CONF_MAN5_SOURCE}
158
159pct.conf.5: ${PCT_CONF_MAN5_SOURCE}
160
b0f56e11 161%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
872bbc1b 162 a2x ${A2X_MAN5_OPTIONS} $*.adoc
f6b81378 163 test -n "$${NOVIEW}" || man -l $@
9344ee0d
DM
164
165.PHONY: cleanup-docgen
166cleanup-docgen:
167 rm -f *.1 *.8 *.adoc attributes.txt docinfo.xml