pve-doc-generator.mk.in

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