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 attributes.txt docinfo.xml:
  72         cp ${DGDIR}/$@ $@.tmp
  73         mv $@.tmp $@
  74
  75 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
  76         ${DGDIR}/gen-$*-opts.pl >$@.tmp
  77         mv $@.tmp $@
  78
  79 %.adoc: ${DGDIR}/gen-%-adoc.pl
  80         ${DGDIR}/gen-$*-adoc.pl >$@.tmp
  81         mv $@.tmp $@
  82
  83 %.1-synopsis.adoc:
  84         perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
  85         mv $@.tmp $@
  86
  87 %.8-synopsis.adoc:
  88         perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
  89         mv $@.tmp $@
  90
  91 ifneq (${DGDIR},.)
  92 %.adoc: ${DGDIR}/%.adoc
  93         cp $< $@.tmp
  94         mv $@.tmp $@
  95 endif
  96
  97 pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
  98         a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-firewall.adoc
  99         test -n "$${NOVIEW}" || man -l $@
 100
 101 pvesm.1: ${PVESM_MAN1_SOURCES}
 102         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvesm.adoc
 103         test -n "$${NOVIEW}" || man -l $@
 104
 105 pct.1: ${PCT_MAN1_SOURCES}
 106         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pct.adoc
 107         test -n "$${NOVIEW}" || man -l $@
 108
 109 qm.1: ${QM_MAN1_SOURCES}
 110         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage qm.adoc
 111         test -n "$${NOVIEW}" || man -l $@
 112
 113 qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
 114         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage qmrestore.adoc
 115         test -n "$${NOVIEW}" || man -l $@
 116
 117 pvecm.1: ${PVECM_MAN1_SOURCES}
 118         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvecm.adoc
 119         test -n "$${NOVIEW}" || man -l $@
 120
 121 pveum.1: ${PVEUM_MAN1_SOURCES}
 122         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pveum.adoc
 123         test -n "$${NOVIEW}" || man -l $@
 124
 125 ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
 126         a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage ha-manager.adoc
 127         test -n "$${NOVIEW}" || man -l $@
 128
 129 pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
 130         a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-ha-crm.adoc
 131         test -n "$${NOVIEW}" || man -l $@
 132
 133 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
 134         a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
 135         test -n "$${NOVIEW}" || man -l $@
 136
 137 .PHONY: cleanup-docgen
 138 cleanup-docgen:
 139         rm -f *.1 *.8 *.adoc attributes.txt docinfo.xml