pmg-doc-generator.mk.in

   1 # also update debian/changelog
   2 DOCRELEASE=5.2
   3
   4 DGDIR?=/usr/share/pmg-doc-generator
   5
   6 ASCIIDOC_PMG?=/usr/bin/asciidoc-pmg
   7
   8 PERL_DOC_ENV=PMG_GENERATING_DOCS=1
   9
  10 PMG_COMMON_DOC_SOURCES=                 \
  11         ${ASCIIDOC_PMG}                 \
  12         pmg-copyright.adoc              \
  13         docinfo.xml
  14
  15 all:
  16
  17 pmgsh.1-synopsis.adoc:
  18         @echo 'Interactive session:' >$@.tmp
  19         @echo '' >>$@.tmp
  20         @echo '*pmgsh*' >>$@.tmp
  21         @echo '' >>$@.tmp
  22         @echo 'Directly call API functions:' >>$@.tmp
  23         @echo '' >>$@.tmp
  24         @echo '*pmgsh* `(get|set|create|help)` `<path>` `[OPTIONS]`' >>$@.tmp
  25         mv $@.tmp $@
  26
  27 pmg-smtp-filter.8-synopsis.adoc:
  28         @echo 'Please use systemd tools to manage this service.' >$@.tmp
  29         @echo '' >>$@.tmp
  30         @echo '*systemctl* `(start|stop|restart|reload|status)` `pmg-smtp-filter`' >>$@.tmp
  31         mv $@.tmp $@
  32
  33 pmgpolicy.8-synopsis.adoc:
  34         @echo 'Please use systemd tools to manage this service.' >$@.tmp
  35         @echo '' >>$@.tmp
  36         @echo '*systemctl* `(start|stop|restart|reload|status)` `pmgpolicy`' >>$@.tmp
  37         mv $@.tmp $@
  38
  39 docinfo.xml:
  40         cp ${DGDIR}/$@ $@.tmp
  41         mv $@.tmp $@
  42
  43 %-opts.adoc: ${DGDIR}/gen-%-opts.pl
  44         $(PERL_DOC_ENV) perl -I. ${DGDIR}/gen-$*-opts.pl >$@.tmp
  45         mv $@.tmp $@
  46
  47 pmg.%-conf-opts.adoc: ${DGDIR}/gen-pmg.conf.5-opts.pl
  48         $(PERL_DOC_ENV) perl -I. ${DGDIR}/gen-pmg.conf.5-opts.pl $* >$@.tmp
  49         mv $@.tmp $@
  50
  51 %.adoc: ${DGDIR}/gen-%-adoc.pl
  52         $(PERL_DOC_ENV) perl -I. ${DGDIR}/gen-$*-adoc.pl >$@.tmp
  53         mv $@.tmp $@
  54
  55 %.1-synopsis.adoc:
  56         $(PERL_DOC_ENV) perl -I. -e "use PMG::CLI::$(subst -,_,$*);print PMG::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
  57         mv $@.tmp $@
  58
  59 %.8-synopsis.adoc:
  60         $(PERL_DOC_ENV) perl -I. -e "use PMG::Service::$(subst -,_,$*);print PMG::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
  61         mv $@.tmp $@
  62
  63 ifneq (${DGDIR},.)
  64 %.adoc: ${DGDIR}/%.adoc
  65         cp $< $@.tmp
  66         mv $@.tmp $@
  67 endif
  68
  69
  70 %-plain.html: %.adoc ${PMG_COMMON_DOC_SOURCES}
  71         ${ASCIIDOC_PMG} compile-wiki -o $@ $*.adoc
  72
  73 chapter-%.html: %.adoc ${PMG_COMMON_DOC_SOURCES}
  74         ${ASCIIDOC_PMG} compile-chapter -o $@ $*.adoc
  75
  76 %.1: %.adoc %.1-synopsis.adoc ${PMG_COMMON_DOC_SOURCES}
  77         ${ASCIIDOC_PMG} compile-man -o $@ $*.adoc
  78         test -n "$${NOVIEW}" || man -l $@
  79
  80 %.1.html: %.adoc %.1-synopsis.adoc ${PMG_COMMON_DOC_SOURCES}
  81         ${ASCIIDOC_PMG} compile-man-html -o $@ $*.adoc
  82
  83 %.8: %.adoc %.8-synopsis.adoc ${PMG_COMMON_DOC_SOURCES}
  84         ${ASCIIDOC_PMG} compile-man -o $@ $*.adoc
  85         test -n "$${NOVIEW}" || man -l $@
  86
  87 %.8.html: %.adoc %.8-synopsis.adoc ${PMG_COMMON_DOC_SOURCES}
  88         ${ASCIIDOC_PMG} compile-man-html -o $@ $*.adoc
  89
  90 %.5: %.adoc %.5-opts.adoc ${PMG_COMMON_DOC_SOURCES}
  91         ${ASCIIDOC_PMG} compile-man -o $@ $*.adoc
  92         test -n "$${NOVIEW}" || man -l $@
  93
  94 %.5.html: %.adoc %.5-opts.adoc ${PMG_COMMON_DOC_SOURCES}
  95         ${ASCIIDOC_PMG} compile-man-html -o $@ $*.adoc
  96
  97 %.5-plain.html: %.adoc %.5-opts.adoc ${PMG_COMMON_DOC_SOURCES}
  98         ${ASCIIDOC_PMG} compile-man-wiki -o $@ $*.adoc
  99
 100
 101 .PHONY: cleanup-docgen
 102 cleanup-docgen:
 103         rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml
 104