X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pve-doc-generator.mk;h=8123cd72ea12fc2c88225ce5238e80980a7d92b8;hb=1a2d79d97ae58820bcf5f25b1d67e33fc5e9f88d;hp=37c8bbbf113f4f16bb474710b5fdcdf4de40c93e;hpb=bca311e4dcc10bf83e4c9a7932c10de19a131251;p=pve-docs.git diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk index 37c8bbb..8123cd7 100644 --- a/pve-doc-generator.mk +++ b/pve-doc-generator.mk @@ -1,8 +1,10 @@ # also update debian/changelog -DOCRELEASE=4.2 +DOCRELEASE=4.3 DGDIR?=/usr/share/pve-doc-generator +ASCIIDOC_PVE?=/usr/bin/asciidoc-pve + all: PVE_COMMON_DOC_SOURCES= \ @@ -33,6 +35,7 @@ PVESM_MAN1_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 \ @@ -138,6 +141,11 @@ PMXCFS_MAN8_SOURCES= \ pmxcfs.8-cli.adoc \ ${PVE_COMMON_DOC_SOURCES} +PVEPERF_MAN1_SOURCES= \ + pveperf.adoc \ + pveperf.1-synopsis.adoc \ + ${PVE_COMMON_DOC_SOURCES} + attributes.txt docinfo.xml: cp ${DGDIR}/$@ $@.tmp mv $@.tmp $@ @@ -150,12 +158,15 @@ 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},.) @@ -164,107 +175,80 @@ ifneq (${DGDIR},.) mv $@.tmp $@ endif -# asciidoc /etc/asciidoc/docbook-xsl/manpage.xsl skip REFERENCES section -# like footnotes, so we cannot use a2x. We use xmlto instead. -#A2MAN_COMMON=a2x -v -k -a docinfo1 -a "manversion=Release ${DOCRELEASE}" -f manpage -#A2MAN1=${A2MAN_COMMON} -a "manvolnum=1" -#A2MAN5=${A2MAN_COMMON} -a "manvolnum=5" -#A2MAN8=${A2MAN_COMMON} -a "manvolnum=8" - -A2MAN_COMMON=asciidoc -dmanpage -bdocbook -a docinfo1 - -define A2MAN1 -${A2MAN_COMMON} -a "manvolnum=1" -o $1.tmp.xml $1.adoc -xmlto -v man $1.tmp.xml -@rm -f $1.tmp.xml -endef - -define A2MAN5 -${A2MAN_COMMON} -a "manvolnum=5" -o $1.tmp.xml $1.adoc -xmlto -v man $1.tmp.xml -@rm -f $1.tmp.xml -endef - -define A2MAN8 -${A2MAN_COMMON} -a "manvolnum=8" -o $1.tmp.xml $1.adoc -xmlto -v man $1.tmp.xml -@rm -f $1.tmp.xml -endef - -pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES} - $(call A2MAN8,pve-firewall) +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} - $(call A2MAN1,pvesm) +pvesm.1: ${PVESM_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pvesm.adoc test -n "$${NOVIEW}" || man -l $@ -pveceph.1: ${PVECEPH_MAN1_SOURCES} - $(call A2MAN1,pveceph) +pveceph.1: ${PVECEPH_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pveceph.adoc test -n "$${NOVIEW}" || man -l $@ -pct.1: ${PCT_MAN1_SOURCES} - $(call A2MAN1,pct) +pct.1: ${PCT_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pct.adoc test -n "$${NOVIEW}" || man -l $@ -vzdump.1: ${VZDUMP_MAN1_SOURCES} - $(call A2MAN1,vzdump) +vzdump.1: ${VZDUMP_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ vzdump.adoc test -n "$${NOVIEW}" || man -l $@ -pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES} - $(call A2MAN1,pvesubscription) +pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pvesubscription.adoc test -n "$${NOVIEW}" || man -l $@ -qm.1: ${QM_MAN1_SOURCES} - $(call A2MAN1,qm) +qm.1: ${QM_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ qm.adoc test -n "$${NOVIEW}" || man -l $@ -qmrestore.1: ${QMRESTORE_MAN1_SOURCES} - $(call A2MAN1,qmrestore) +qmrestore.1: ${QMRESTORE_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ qmrestore.adoc test -n "$${NOVIEW}" || man -l $@ -pvecm.1: ${PVECM_MAN1_SOURCES} - $(call A2MAN1,pvecm) +pvecm.1: ${PVECM_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pvecm.adoc test -n "$${NOVIEW}" || man -l $@ -pveum.1: ${PVEUM_MAN1_SOURCES} - $(call A2MAN1,pveum) +pveum.1: ${PVEUM_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pveum.adoc test -n "$${NOVIEW}" || man -l $@ -pveam.1: ${PVEAM_MAN1_SOURCES} - $(call A2MAN1,pveam) +pveam.1: ${PVEAM_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pveam.adoc test -n "$${NOVIEW}" || man -l $@ -ha-manager.1: ${HA_MANAGER_MAN1_SOURCES} - $(call A2MAN1,ha-manager) +ha-manager.1: ${HA_MANAGER_MAN1_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ ha-manager.adoc test -n "$${NOVIEW}" || man -l $@ -pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES} - $(call A2MAN8,pve-ha-crm) +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 $@ -pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES} - $(call A2MAN8,pve-ha-lrm) +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 $@ -pvestatd.8: ${PVESTATD_MAN8_SOURCES} - $(call A2MAN8,pvestatd) +pvestatd.8: ${PVESTATD_MAN8_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pvestatd.adoc test -n "$${NOVIEW}" || man -l $@ -pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES} - $(call A2MAN8,pvedaemon) +pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pvedaemon.adoc test -n "$${NOVIEW}" || man -l $@ -pveproxy.8: ${PVEPROXY_MAN8_SOURCES} - $(call A2MAN8,pveproxy) +pveproxy.8: ${PVEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ pveproxy.adoc test -n "$${NOVIEW}" || man -l $@ -spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES} - $(call A2MAN8,spiceproxy) +spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE} + ${ASCIIDOC_PVE} compile-man -o $@ spiceproxy.adoc test -n "$${NOVIEW}" || man -l $@ -pmxcfs.8: ${PMXCFS_MAN8_SOURCES} - $(call A2MAN8,pmxcfs) +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} @@ -273,8 +257,8 @@ pct.conf.5: ${PCT_CONF_MAN5_SOURCES} datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES} -%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} - $(call A2MAN5,$*) +%.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