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