cleanup Makefile
[pve-docs.git] / pve-doc-generator.mk
1 # also update debian/changelog
2 DOCRELEASE=4.1
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 PCT_MAN1_SOURCES= \
42 pct.adoc \
43 pct.1-synopsis.adoc \
44 ${PVE_COMMON_DOC_SOURCES}
45
46 PCT_CONF_MAN5_SOURCES= \
47 pct.conf.adoc \
48 pct.conf.5-opts.adoc \
49 ${PVE_COMMON_DOC_SOURCES}
50
51 DATACENTER_CONF_MAN5_SOURCES= \
52 datacenter.cfg.adoc \
53 datacenter.cfg.5-opts.adoc \
54 ${PVE_COMMON_DOC_SOURCES}
55
56 QM_MAN1_SOURCES= \
57 qm.adoc \
58 qm.1-synopsis.adoc \
59 ${PVE_COMMON_DOC_SOURCES}
60
61 QM_CONF_MAN5_SOURCES= \
62 qm.conf.adoc \
63 qm.conf.5-opts.adoc \
64 ${PVE_COMMON_DOC_SOURCES}
65
66 QMRESTORE_MAN1_SOURCES= \
67 qmrestore.adoc \
68 qmrestore.1-synopsis.adoc \
69 ${PVE_COMMON_DOC_SOURCES}
70
71 PVEUM_MAN1_SOURCES= \
72 pveum.adoc \
73 pveum.1-synopsis.adoc \
74 ${PVE_COMMON_DOC_SOURCES}
75
76 HA_MANAGER_MAN1_SOURCES= \
77 ha-manager.adoc \
78 ha-manager.1-synopsis.adoc \
79 ${PVE_COMMON_DOC_SOURCES}
80
81 PVE_HA_CRM_MAN8_SOURCES= \
82 pve-ha-crm.adoc \
83 pve-ha-crm.8-synopsis.adoc \
84 ${PVE_COMMON_DOC_SOURCES}
85
86 PVE_HA_LRM_MAN8_SOURCES= \
87 pve-ha-lrm.adoc \
88 pve-ha-lrm.8-synopsis.adoc \
89 ${PVE_COMMON_DOC_SOURCES}
90
91 PVESTATD_MAN8_SOURCES= \
92 pvestatd.adoc \
93 pvestatd.8-synopsis.adoc \
94 ${PVE_COMMON_DOC_SOURCES}
95
96 attributes.txt docinfo.xml:
97 cp ${DGDIR}/$@ $@.tmp
98 mv $@.tmp $@
99
100 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
101 ${DGDIR}/gen-$*-opts.pl >$@.tmp
102 mv $@.tmp $@
103
104 %.adoc: ${DGDIR}/gen-%-adoc.pl
105 ${DGDIR}/gen-$*-adoc.pl >$@.tmp
106 mv $@.tmp $@
107
108 %.1-synopsis.adoc:
109 perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
110 mv $@.tmp $@
111
112 %.8-synopsis.adoc:
113 perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
114 mv $@.tmp $@
115
116 ifneq (${DGDIR},.)
117 %.adoc: ${DGDIR}/%.adoc
118 cp $< $@.tmp
119 mv $@.tmp $@
120 endif
121
122 A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
123 A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
124 A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
125 A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
126
127 pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
128 a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
129 test -n "$${NOVIEW}" || man -l $@
130
131 pvesm.1: ${PVESM_MAN1_SOURCES}
132 a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
133 test -n "$${NOVIEW}" || man -l $@
134
135 pct.1: ${PCT_MAN1_SOURCES}
136 a2x ${A2X_MAN1_OPTIONS} pct.adoc
137 test -n "$${NOVIEW}" || man -l $@
138
139 qm.1: ${QM_MAN1_SOURCES}
140 a2x ${A2X_MAN1_OPTIONS} qm.adoc
141 test -n "$${NOVIEW}" || man -l $@
142
143 qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
144 a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
145 test -n "$${NOVIEW}" || man -l $@
146
147 pvecm.1: ${PVECM_MAN1_SOURCES}
148 a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
149 test -n "$${NOVIEW}" || man -l $@
150
151 pveum.1: ${PVEUM_MAN1_SOURCES}
152 a2x ${A2X_MAN1_OPTIONS} pveum.adoc
153 test -n "$${NOVIEW}" || man -l $@
154
155 ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
156 a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
157 test -n "$${NOVIEW}" || man -l $@
158
159 pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
160 a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
161 test -n "$${NOVIEW}" || man -l $@
162
163 pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
164 a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
165 test -n "$${NOVIEW}" || man -l $@
166
167 pvestatd.8: ${PVESTATD_MAN8_SOURCES}
168 a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
169 test -n "$${NOVIEW}" || man -l $@
170
171 qm.conf.5: ${QM_CONF_MAN5_SOURCES}
172
173 pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
174
175 datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
176
177 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
178 a2x ${A2X_MAN5_OPTIONS} $*.adoc
179 test -n "$${NOVIEW}" || man -l $@
180
181 .PHONY: cleanup-docgen
182 cleanup-docgen:
183 rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml