1 # also update debian/changelog
4 DGDIR?
=/usr
/share
/pve-doc-generator
6 ASCIIDOC_PVE?
=/usr
/bin
/asciidoc-pve
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})
12 PVE_COMMON_DOC_SOURCES
= \
19 attributes.txt docinfo.xml pmxcfs
.8-synopsis.adoc qmeventd
.8-synopsis.adoc
:
23 %-opts.adoc
: ${DGDIR}/gen-
%-opts.pl
24 $(PERL_DOC_ENV
) perl
${PERL_DOC_INC} ${DGDIR}/gen-
$*-opts.pl
>$@.tmp
27 %.adoc
: ${DGDIR}/gen-
%-adoc.pl
28 $(PERL_DOC_ENV
) perl
${PERL_DOC_INC} ${DGDIR}/gen-
$*-adoc.pl
>$@.tmp
31 pveperf
.1-synopsis.adoc
:
32 echo
'*pveperf* `[PATH]`' > pveperf
.1-synopsis.adoc
35 $(PERL_DOC_ENV
) perl
${PERL_DOC_INC} -e
"use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
39 $(PERL_DOC_ENV
) perl
${PERL_DOC_INC} -e
"use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
43 %.adoc
: ${DGDIR}/%.adoc
48 %.service-bash-completion
:
49 perl
${PERL_DOC_INC} -T
-e
"use PVE::Service::$*; PVE::Service::$*->generate_bash_completions();" >$@.tmp
53 perl
${PERL_DOC_INC} -T
-e
"use PVE::CLI::$*; PVE::CLI::$*->generate_bash_completions();" >$@.tmp
56 %.service-zsh-completion
:
57 perl
${PERL_DOC_INC} -T
-e
"use PVE::Service::$*; PVE::Service::$*->generate_zsh_completions();" >$@.tmp
61 perl
${PERL_DOC_INC} -T
-e
"use PVE::CLI::$*; PVE::CLI::$*->generate_zsh_completions();" >$@.tmp
64 %.service-api-verified
:
65 perl
${PERL_DOC_INC} -T
-e
"use PVE::Service::$*; PVE::Service::$*->verify_api();"
69 perl
${PERL_DOC_INC} -T
-e
"use PVE::CLI::$*; PVE::CLI::$*->verify_api();"
72 %-plain.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
73 ${ASCIIDOC_PVE} compile-wiki
-o
$@
$*.adoc
75 chapter-
%.html
: %.adoc
${PVE_COMMON_DOC_SOURCES}
76 ${ASCIIDOC_PVE} compile-chapter
-o
$@
$*.adoc
78 %.1: %.adoc
%.1-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
79 ${ASCIIDOC_PVE} compile-man
-o
$@
$*.adoc
80 test -n
"$${NOVIEW}" || man
-l
$@
82 %.1.html
: %.adoc
%.1-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
83 ${ASCIIDOC_PVE} compile-man-html
-o
$@
$*.adoc
85 %.8: %.adoc
%.8-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
86 ${ASCIIDOC_PVE} compile-man
-o
$@
$*.adoc
87 test -n
"$${NOVIEW}" || man
-l
$@
89 %.8.html
: %.adoc
%.8-synopsis.adoc
${PVE_COMMON_DOC_SOURCES}
90 ${ASCIIDOC_PVE} compile-man-html
-o
$@
$*.adoc
92 %.5: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
93 ${ASCIIDOC_PVE} compile-man
-o
$@
$*.adoc
94 test -n
"$${NOVIEW}" || man
-l
$@
96 %.5.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
97 ${ASCIIDOC_PVE} compile-man-html
-o
$@
$*.adoc
99 %.5-plain.html
: %.adoc
%.5-opts.adoc
${PVE_COMMON_DOC_SOURCES}
100 ${ASCIIDOC_PVE} compile-man-wiki
-o
$@
$*.adoc
103 .PHONY
: cleanup-docgen
105 rm -f
*.xml.tmp
*.1 *.5 *.8 *.adoc docinfo.xml