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 QM_MAN1_SOURCES=                        \
  47         qm.adoc                         \
  48         qm.1-synopsis.adoc              \
  49         ${PVE_COMMON_DOC_SOURCES}
  50
  51 QMRESTORE_MAN1_SOURCES=                 \
  52         qmrestore.adoc                  \
  53         qmrestore.1-synopsis.adoc       \
  54         ${PVE_COMMON_DOC_SOURCES}
  55
  56 PVEUM_MAN1_SOURCES=                     \
  57         pveum.adoc                      \
  58         pveum.1-synopsis.adoc           \
  59         ${PVE_COMMON_DOC_SOURCES}
  60
  61 HA_MANAGER_MAN1_SOURCES=                        \
  62         ha-manager.adoc                         \
  63         ha-manager.1-synopsis.adoc              \
  64         ${PVE_COMMON_DOC_SOURCES}
  65
  66 PVE_HA_CRM_MAN8_SOURCES=                        \
  67         pve-ha-crm.adoc                         \
  68         pve-ha-crm.8-synopsis.adoc              \
  69         ${PVE_COMMON_DOC_SOURCES}
  70
  71 PVE_HA_LRM_MAN8_SOURCES=                        \
  72         pve-ha-lrm.adoc                         \
  73         pve-ha-lrm.8-synopsis.adoc              \
  74         ${PVE_COMMON_DOC_SOURCES}
  75
  76 attributes.txt docinfo.xml:
  77         cp ${DGDIR}/$@ $@.tmp
  78         mv $@.tmp $@
  79
  80 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
  81         ${DGDIR}/gen-$*-opts.pl >$@.tmp
  82         mv $@.tmp $@
  83
  84 %.adoc: ${DGDIR}/gen-%-adoc.pl
  85         ${DGDIR}/gen-$*-adoc.pl >$@.tmp
  86         mv $@.tmp $@
  87
  88 %.1-synopsis.adoc:
  89         perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
  90         mv $@.tmp $@
  91
  92 %.8-synopsis.adoc:
  93         perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
  94         mv $@.tmp $@
  95
  96 ifneq (${DGDIR},.)
  97 %.adoc: ${DGDIR}/%.adoc
  98         cp $< $@.tmp
  99         mv $@.tmp $@
 100 endif
 101
 102 A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
 103 A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
 104 A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
 105 A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
 106
 107 pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
 108         a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
 109         test -n "$${NOVIEW}" || man -l $@
 110
 111 pvesm.1: ${PVESM_MAN1_SOURCES}
 112         a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
 113         test -n "$${NOVIEW}" || man -l $@
 114
 115 pct.1: ${PCT_MAN1_SOURCES}
 116         a2x ${A2X_MAN1_OPTIONS} pct.adoc
 117         test -n "$${NOVIEW}" || man -l $@
 118
 119 qm.1: ${QM_MAN1_SOURCES}
 120         a2x ${A2X_MAN1_OPTIONS} qm.adoc
 121         test -n "$${NOVIEW}" || man -l $@
 122
 123 qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
 124         a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
 125         test -n "$${NOVIEW}" || man -l $@
 126
 127 pvecm.1: ${PVECM_MAN1_SOURCES}
 128         a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
 129         test -n "$${NOVIEW}" || man -l $@
 130
 131 pveum.1: ${PVEUM_MAN1_SOURCES}
 132         a2x ${A2X_MAN1_OPTIONS} pveum.adoc
 133         test -n "$${NOVIEW}" || man -l $@
 134
 135 ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
 136         a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
 137         test -n "$${NOVIEW}" || man -l $@
 138
 139 pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
 140         a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
 141         test -n "$${NOVIEW}" || man -l $@
 142
 143 pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
 144         a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
 145         test -n "$${NOVIEW}" || man -l $@
 146
 147 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
 148         a2x ${A2X_MAN5_OPTIONS} $*.adoc
 149         test -n "$${NOVIEW}" || man -l $@
 150
 151 .PHONY: cleanup-docgen
 152 cleanup-docgen:
 153         rm -f *.1 *.8 *.adoc attributes.txt docinfo.xml