pve-doc-generator.mk.in

   1 # also update debian/changelog
   2 DOCRELEASE=5.3
   3
   4 DGDIR?=/usr/share/pve-doc-generator
   5
   6 ASCIIDOC_PVE?=/usr/bin/asciidoc-pve
   7
   8 PERL_DOC_ENV=PVE_GENERATING_DOCS=1
   9 PERL_DOC_INC_DIRS:=${PERL_DOC_INC_DIRS} .
  10 PERL_DOC_INC=$(foreach dir,${PERL_DOC_INC_DIRS},-I${dir})
  11
  12 PVE_COMMON_DOC_SOURCES=                 \
  13         ${ASCIIDOC_PVE}                 \
  14         pve-copyright.adoc              \
  15         docinfo.xml
  16
  17 all:
  18
  19 attributes.txt docinfo.xml pmxcfs.8-synopsis.adoc qmeventd.8-synopsis.adoc:
  20         cp ${DGDIR}/$@ $@.tmp
  21         mv $@.tmp $@
  22
  23 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
  24         $(PERL_DOC_ENV) perl ${PERL_DOC_INC} ${DGDIR}/gen-$*-opts.pl >$@.tmp
  25         mv $@.tmp $@
  26
  27 %.adoc: ${DGDIR}/gen-%-adoc.pl
  28         $(PERL_DOC_ENV) perl ${PERL_DOC_INC} ${DGDIR}/gen-$*-adoc.pl >$@.tmp
  29         mv $@.tmp $@
  30
  31 pveperf.1-synopsis.adoc:
  32         echo '*pveperf* `[PATH]`' > pveperf.1-synopsis.adoc
  33
  34 %.1-synopsis.adoc:
  35         $(PERL_DOC_ENV) perl ${PERL_DOC_INC} -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
  36         mv $@.tmp $@
  37
  38 %.8-synopsis.adoc:
  39         $(PERL_DOC_ENV) perl ${PERL_DOC_INC} -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
  40         mv $@.tmp $@
  41
  42 ifneq (${DGDIR},.)
  43 %.adoc: ${DGDIR}/%.adoc
  44         cp $< $@.tmp
  45         mv $@.tmp $@
  46 endif
  47
  48 %.service-bash-completion:
  49         perl ${PERL_DOC_INC} -T -e "use PVE::Service::$*; PVE::Service::$*->generate_bash_completions();" >$@.tmp
  50         mv $@.tmp $@
  51
  52 %.bash-completion:
  53         perl ${PERL_DOC_INC} -T -e "use PVE::CLI::$*; PVE::CLI::$*->generate_bash_completions();" >$@.tmp
  54         mv $@.tmp $@
  55
  56 %.service-api-verified:
  57         perl ${PERL_DOC_INC} -T -e "use PVE::Service::$*; PVE::Service::$*->verify_api();"
  58         touch $@
  59
  60 %.api-verified:
  61         perl ${PERL_DOC_INC} -T -e "use PVE::CLI::$*; PVE::CLI::$*->verify_api();"
  62         touch $@
  63
  64 %-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
  65         ${ASCIIDOC_PVE} compile-wiki -o $@ $*.adoc
  66
  67 chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
  68         ${ASCIIDOC_PVE} compile-chapter -o $@ $*.adoc
  69
  70 %.1: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
  71         ${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
  72         test -n "$${NOVIEW}" || man -l $@
  73
  74 %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
  75         ${ASCIIDOC_PVE} compile-man-html -o $@ $*.adoc
  76
  77 %.8: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
  78         ${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
  79         test -n "$${NOVIEW}" || man -l $@
  80
  81 %.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
  82         ${ASCIIDOC_PVE} compile-man-html -o $@ $*.adoc
  83
  84 %.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
  85         ${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
  86         test -n "$${NOVIEW}" || man -l $@
  87
  88 %.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
  89         ${ASCIIDOC_PVE} compile-man-html -o $@ $*.adoc
  90
  91 %.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
  92         ${ASCIIDOC_PVE} compile-man-wiki -o $@ $*.adoc
  93
  94
  95 .PHONY: cleanup-docgen
  96 cleanup-docgen:
  97         rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml