# also update debian/changelog
-DOCRELEASE=4.1
+DOCRELEASE=4.3
DGDIR?=/usr/share/pve-doc-generator
+ASCIIDOC_PVE?=asciidoc-pve
+
all:
PVE_COMMON_DOC_SOURCES= \
pve-storage-iscsi.adoc \
pve-storage-iscsidirect.adoc \
pve-storage-lvm.adoc \
+ pve-storage-lvmthin.adoc \
pve-storage-nfs.adoc \
pve-storage-rbd.adoc \
pve-storage-zfspool.adoc \
${PVE_COMMON_DOC_SOURCES}
+VZDUMP_MAN1_SOURCES= \
+ vzdump.adoc \
+ vzdump.1-synopsis.adoc \
+ vzdump.conf.5-opts.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVESUBSCRIPTION_MAN1_SOURCES= \
+ pvesubscription.adoc \
+ pvesubscription.1-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVECEPH_MAN1_SOURCES= \
+ pveceph.adoc \
+ pveceph.1-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
PCT_MAN1_SOURCES= \
pct.adoc \
pct.1-synopsis.adoc \
+ pct.conf.5-opts.adoc \
+ pct-network-opts.adoc \
+ pct-mountpoint-opts.adoc \
${PVE_COMMON_DOC_SOURCES}
-PCT_CONF_MAN5_SOURCE= \
+PCT_CONF_MAN5_SOURCES= \
pct.conf.adoc \
pct.conf.5-opts.adoc \
${PVE_COMMON_DOC_SOURCES}
+DATACENTER_CONF_MAN5_SOURCES= \
+ datacenter.cfg.adoc \
+ datacenter.cfg.5-opts.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
QM_MAN1_SOURCES= \
qm.adoc \
qm.1-synopsis.adoc \
+ qm.conf.5-opts.adoc \
${PVE_COMMON_DOC_SOURCES}
-QM_CONF_MAN5_SOURCE= \
+QM_CONF_MAN5_SOURCES= \
qm.conf.adoc \
qm.conf.5-opts.adoc \
${PVE_COMMON_DOC_SOURCES}
pveum.1-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
-HA_MANAGER_MAN1_SOURCES= \
- ha-manager.adoc \
- ha-manager.1-synopsis.adoc \
+PVEAM_MAN1_SOURCES= \
+ pveam.adoc \
+ pveam.1-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+HA_MANAGER_MAN1_SOURCES= \
+ ha-manager.adoc \
+ ha-manager.1-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVE_HA_CRM_MAN8_SOURCES= \
+ pve-ha-crm.adoc \
+ pve-ha-crm.8-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVE_HA_LRM_MAN8_SOURCES= \
+ pve-ha-lrm.adoc \
+ pve-ha-lrm.8-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVESTATD_MAN8_SOURCES= \
+ pvestatd.adoc \
+ pvestatd.8-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVEDAEMON_MAN8_SOURCES= \
+ pvedaemon.adoc \
+ pvedaemon.8-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+PVEPROXY_MAN8_SOURCES= \
+ pveproxy.adoc \
+ pveproxy.8-synopsis.adoc \
+ ${PVE_COMMON_DOC_SOURCES}
+
+SPICEPROXY_MAN8_SOURCES= \
+ spiceproxy.adoc \
+ spiceproxy.8-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
-PVE_HA_CRM_MAN8_SOURCES= \
- pve-ha-crm.adoc \
- pve-ha-crm.8-synopsis.adoc \
+PMXCFS_MAN8_SOURCES= \
+ pmxcfs.adoc \
+ pmxcfs.8-cli.adoc \
${PVE_COMMON_DOC_SOURCES}
-PVE_HA_LRM_MAN8_SOURCES= \
- pve-ha-lrm.adoc \
- pve-ha-lrm.8-synopsis.adoc \
+PVEPERF_MAN1_SOURCES= \
+ pveperf.adoc \
+ pveperf.1-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}
attributes.txt docinfo.xml:
${DGDIR}/gen-$*-adoc.pl >$@.tmp
mv $@.tmp $@
+pveperf.1-synopsis.adoc:
+ echo '*pveperf* `[PATH]`' > pveperf.1-synopsis.adoc
+
%.1-synopsis.adoc:
- perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
+ perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
mv $@.tmp $@
%.8-synopsis.adoc:
- perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
+ perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
mv $@.tmp $@
ifneq (${DGDIR},.)
mv $@.tmp $@
endif
-A2X_MAN_COMMON_OPTIONS=-a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage
-A2X_MAN1_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=1"
-A2X_MAN5_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=5"
-A2X_MAN8_OPTIONS=${A2X_MAN_COMMON_OPTIONS} -a "manvolnum=8"
+pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pve-firewall.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+pvesm.1: ${PVESM_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pvesm.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+pveceph.1: ${PVECEPH_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pveceph.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+pct.1: ${PCT_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pct.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+vzdump.1: ${VZDUMP_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ vzdump.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pvesubscription.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+qm.1: ${QM_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ qm.adoc
+ test -n "$${NOVIEW}" || man -l $@
-pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
- a2x ${A2X_MAN8_OPTIONS} pve-firewall.adoc
+qmrestore.1: ${QMRESTORE_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ qmrestore.adoc
test -n "$${NOVIEW}" || man -l $@
-pvesm.1: ${PVESM_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} pvesm.adoc
+pvecm.1: ${PVECM_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pvecm.adoc
test -n "$${NOVIEW}" || man -l $@
-pct.1: ${PCT_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} pct.adoc
+pveum.1: ${PVEUM_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pveum.adoc
test -n "$${NOVIEW}" || man -l $@
-qm.1: ${QM_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} qm.adoc
+pveam.1: ${PVEAM_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pveam.adoc
test -n "$${NOVIEW}" || man -l $@
-qmrestore.1: ${QMRESTORE_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} qmrestore.adoc
+ha-manager.1: ${HA_MANAGER_MAN1_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ ha-manager.adoc
test -n "$${NOVIEW}" || man -l $@
-pvecm.1: ${PVECM_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} pvecm.adoc
+pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pve-ha-crm.adoc
test -n "$${NOVIEW}" || man -l $@
-pveum.1: ${PVEUM_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} pveum.adoc
+pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pve-ha-lrm.adoc
test -n "$${NOVIEW}" || man -l $@
-ha-manager.1: ${HA_MANAGER_MAN1_SOURCES}
- a2x ${A2X_MAN1_OPTIONS} ha-manager.adoc
+pvestatd.8: ${PVESTATD_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pvestatd.adoc
test -n "$${NOVIEW}" || man -l $@
-pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES}
- a2x ${A2X_MAN8_OPTIONS} manpage pve-ha-crm.adoc
+pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pvedaemon.adoc
test -n "$${NOVIEW}" || man -l $@
-pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES}
- a2x ${A2X_MAN8_OPTIONS} pve-ha-lrm.adoc
+pveproxy.8: ${PVEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pveproxy.adoc
test -n "$${NOVIEW}" || man -l $@
-qm.conf.5: ${QM_CONF_MAN5_SOURCE}
+spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ spiceproxy.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+pmxcfs.8: ${PMXCFS_MAN8_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ pmxcfs.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+qm.conf.5: ${QM_CONF_MAN5_SOURCES}
+
+pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
-pct.conf.5: ${PCT_CONF_MAN5_SOURCE}
+datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
-%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
- a2x ${A2X_MAN5_OPTIONS} $*.adoc
+%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} ${ASCIIDOC_PVE}
+ ${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
test -n "$${NOVIEW}" || man -l $@
.PHONY: cleanup-docgen
cleanup-docgen:
- rm -f *.1 *.8 *.adoc attributes.txt docinfo.xml
+ rm -f *.tmp.xml *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
projects / pve-docs.git / blobdiff