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