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-network-opts.adoc           \
  61         pct-mountpoint-opts.adoc        \
  62         ${PVE_COMMON_DOC_SOURCES}
  63
  64 PCT_CONF_MAN5_SOURCES=                  \
  65         pct.conf.adoc                   \
  66         pct.conf.5-opts.adoc            \
  67         ${PVE_COMMON_DOC_SOURCES}
  68
  69 DATACENTER_CONF_MAN5_SOURCES=           \
  70         datacenter.cfg.adoc             \
  71         datacenter.cfg.5-opts.adoc      \
  72         ${PVE_COMMON_DOC_SOURCES}
  73
  74 QM_MAN1_SOURCES=                        \
  75         qm.adoc                         \
  76         qm.1-synopsis.adoc              \
  77         ${PVE_COMMON_DOC_SOURCES}
  78
  79 QM_CONF_MAN5_SOURCES=                   \
  80         qm.conf.adoc                    \
  81         qm.conf.5-opts.adoc             \
  82         ${PVE_COMMON_DOC_SOURCES}
  83
  84 QMRESTORE_MAN1_SOURCES=                 \
  85         qmrestore.adoc                  \
  86         qmrestore.1-synopsis.adoc       \
  87         ${PVE_COMMON_DOC_SOURCES}
  88
  89 PVEUM_MAN1_SOURCES=                     \
  90         pveum.adoc                      \
  91         pveum.1-synopsis.adoc           \
  92         ${PVE_COMMON_DOC_SOURCES}
  93
  94 PVEAM_MAN1_SOURCES=                     \
  95         pveam.adoc                      \
  96         pveam.1-synopsis.adoc           \
  97         ${PVE_COMMON_DOC_SOURCES}
  98
  99 HA_MANAGER_MAN1_SOURCES=                \
 100         ha-manager.adoc                 \
 101         ha-manager.1-synopsis.adoc      \
 102         ${PVE_COMMON_DOC_SOURCES}
 103
 104 PVE_HA_CRM_MAN8_SOURCES=                \
 105         pve-ha-crm.adoc                 \
 106         pve-ha-crm.8-synopsis.adoc      \
 107         ${PVE_COMMON_DOC_SOURCES}
 108
 109 PVE_HA_LRM_MAN8_SOURCES=                \
 110         pve-ha-lrm.adoc                 \
 111         pve-ha-lrm.8-synopsis.adoc      \
 112         ${PVE_COMMON_DOC_SOURCES}
 113
 114 PVESTATD_MAN8_SOURCES=                  \
 115         pvestatd.adoc                   \
 116         pvestatd.8-synopsis.adoc        \
 117         ${PVE_COMMON_DOC_SOURCES}
 118
 119 PVEDAEMON_MAN8_SOURCES=                 \
 120         pvedaemon.adoc                  \
 121         pvedaemon.8-synopsis.adoc       \
 122         ${PVE_COMMON_DOC_SOURCES}
 123
 124 PVEPROXY_MAN8_SOURCES=                  \
 125         pveproxy.adoc                   \
 126         pveproxy.8-synopsis.adoc        \
 127         ${PVE_COMMON_DOC_SOURCES}
 128
 129 SPICEPROXY_MAN8_SOURCES=                \
 130         spiceproxy.adoc                 \
 131         spiceproxy.8-synopsis.adoc      \
 132         ${PVE_COMMON_DOC_SOURCES}
 133
 134 PMXCFS_MAN8_SOURCES=                    \
 135         pmxcfs.adoc                     \
 136         pmxcfs.8-cli.adoc               \
 137         ${PVE_COMMON_DOC_SOURCES}
 138
 139 attributes.txt docinfo.xml:
 140         cp ${DGDIR}/$@ $@.tmp
 141         mv $@.tmp $@
 142
 143 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
 144         ${DGDIR}/gen-$*-opts.pl >$@.tmp
 145         mv $@.tmp $@
 146
 147 %.adoc: ${DGDIR}/gen-%-adoc.pl
 148         ${DGDIR}/gen-$*-adoc.pl >$@.tmp
 149         mv $@.tmp $@
 150
 151 %.1-synopsis.adoc:
 152         perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
 153         mv $@.tmp $@
 154
 155 %.8-synopsis.adoc:
 156         perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
 157         mv $@.tmp $@
 158
 159 ifneq (${DGDIR},.)
 160 %.adoc: ${DGDIR}/%.adoc
 161         cp $< $@.tmp
 162         mv $@.tmp $@
 163 endif
 164
 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"
 169
 170 pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
 171         a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
 172         test -n "$${NOVIEW}" || man -l $@
 173
 174 pvesm.1: ${PVESM_MAN1_SOURCES}
 175         a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
 176         test -n "$${NOVIEW}" || man -l $@
 177
 178 pveceph.1: ${PVECEPH_MAN1_SOURCES}
 179         a2x ${A2X_MAN1_OPTIONS} pveceph.adoc
 180         test -n "$${NOVIEW}" || man -l $@
 181
 182 pct.1: ${PCT_MAN1_SOURCES}
 183         a2x ${A2X_MAN1_OPTIONS} pct.adoc
 184         test -n "$${NOVIEW}" || man -l $@
 185
 186 vzdump.1: ${VZDUMP_MAN1_SOURCES}
 187         a2x ${A2X_MAN1_OPTIONS} vzdump.adoc
 188         test -n "$${NOVIEW}" || man -l $@
 189
 190 pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES}
 191         a2x ${A2X_MAN1_OPTIONS} pvesubscription.adoc
 192         test -n "$${NOVIEW}" || man -l $@
 193
 194 qm.1: ${QM_MAN1_SOURCES}
 195         a2x ${A2X_MAN1_OPTIONS} qm.adoc
 196         test -n "$${NOVIEW}" || man -l $@
 197
 198 qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
 199         a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
 200         test -n "$${NOVIEW}" || man -l $@
 201
 202 pvecm.1: ${PVECM_MAN1_SOURCES}
 203         a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
 204         test -n "$${NOVIEW}" || man -l $@
 205
 206 pveum.1: ${PVEUM_MAN1_SOURCES}
 207         a2x ${A2X_MAN1_OPTIONS} pveum.adoc
 208         test -n "$${NOVIEW}" || man -l $@
 209
 210 pveam.1: ${PVEAM_MAN1_SOURCES}
 211         a2x ${A2X_MAN1_OPTIONS} pveam.adoc
 212         test -n "$${NOVIEW}" || man -l $@
 213
 214 ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
 215         a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
 216         test -n "$${NOVIEW}" || man -l $@
 217
 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 $@
 221
 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 $@
 225
 226 pvestatd.8: ${PVESTATD_MAN8_SOURCES}
 227         a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc
 228         test -n "$${NOVIEW}" || man -l $@
 229
 230 pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
 231         a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
 232         test -n "$${NOVIEW}" || man -l $@
 233
 234 pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
 235         a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
 236         test -n "$${NOVIEW}" || man -l $@
 237
 238 spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES}
 239         a2x ${A2X_MAN8_OPTIONS} spiceproxy.adoc
 240         test -n "$${NOVIEW}" || man -l $@
 241
 242 pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
 243         a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
 244         test -n "$${NOVIEW}" || man -l $@
 245
 246 qm.conf.5: ${QM_CONF_MAN5_SOURCES}
 247
 248 pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
 249
 250 datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
 251
 252 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
 253         a2x ${A2X_MAN5_OPTIONS} $*.adoc
 254         test -n "$${NOVIEW}" || man -l $@
 255
 256 .PHONY: cleanup-docgen
 257 cleanup-docgen:
 258         rm -f *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml