X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=pve-doc-generator.mk.in;h=7fc159d507cfb1de64a738674e1f89912e27a55e;hp=0bd2a2c4cb9647f1701917c7bd9621dfb429119b;hb=b08ec024092a2f71d1604ff6f3bf4dc3050ab47d;hpb=540791016979f4ec2e83cd1933872f3266a10da6 diff --git a/pve-doc-generator.mk.in b/pve-doc-generator.mk.in index 0bd2a2c..7fc159d 100644 --- a/pve-doc-generator.mk.in +++ b/pve-doc-generator.mk.in @@ -1,39 +1,42 @@ # also update debian/changelog -DOCRELEASE=4.3 +DOCRELEASE=5.2 DGDIR?=/usr/share/pve-doc-generator ASCIIDOC_PVE?=/usr/bin/asciidoc-pve +PERL_DOC_ENV=PVE_GENERATING_DOCS=1 +PERL_DOC_INC_DIRS:=${PERL_DOC_INC_DIRS} . +PERL_DOC_INC=$(foreach dir,${PERL_DOC_INC_DIRS},-I${dir}) + PVE_COMMON_DOC_SOURCES= \ ${ASCIIDOC_PVE} \ - attributes.txt \ pve-copyright.adoc \ docinfo.xml all: -attributes.txt docinfo.xml pmxcfs.8-synopsis.adoc: +attributes.txt docinfo.xml pmxcfs.8-synopsis.adoc qmeventd.8-synopsis.adoc: cp ${DGDIR}/$@ $@.tmp mv $@.tmp $@ %-opts.adoc: ${DGDIR}/gen-%-opts.pl - ${DGDIR}/gen-$*-opts.pl >$@.tmp + $(PERL_DOC_ENV) perl ${PERL_DOC_INC} ${DGDIR}/gen-$*-opts.pl >$@.tmp mv $@.tmp $@ %.adoc: ${DGDIR}/gen-%-adoc.pl - ${DGDIR}/gen-$*-adoc.pl >$@.tmp + $(PERL_DOC_ENV) perl ${PERL_DOC_INC} ${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_synopsis();" > $@.tmp + $(PERL_DOC_ENV) perl ${PERL_DOC_INC} -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_synopsis();" > $@.tmp + $(PERL_DOC_ENV) perl ${PERL_DOC_INC} -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp mv $@.tmp $@ ifneq (${DGDIR},.) @@ -42,6 +45,21 @@ ifneq (${DGDIR},.) mv $@.tmp $@ endif +%.service-bash-completion: + perl ${PERL_DOC_INC} -T -e "use PVE::Service::$*; PVE::Service::$*->generate_bash_completions();" >$@.tmp + mv $@.tmp $@ + +%.bash-completion: + perl ${PERL_DOC_INC} -T -e "use PVE::CLI::$*; PVE::CLI::$*->generate_bash_completions();" >$@.tmp + mv $@.tmp $@ + +%.service-api-verified: + perl ${PERL_DOC_INC} -T -e "use PVE::Service::$*; PVE::Service::$*->verify_api();" + touch $@ + +%.api-verified: + perl ${PERL_DOC_INC} -T -e "use PVE::CLI::$*; PVE::CLI::$*->verify_api();" + touch $@ %-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES} ${ASCIIDOC_PVE} compile-wiki -o $@ $*.adoc @@ -76,4 +94,4 @@ chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES} .PHONY: cleanup-docgen cleanup-docgen: - rm -f *.xml.tmp *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml + rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml