mirror of
https://git.proxmox.com/git/pve-docs
synced 2025-06-14 19:48:03 +00:00
embed autogenerated rules inside pve-doc-generator.mk
This commit is contained in:
Dietmar Maurer
parent
63a0180693
commit
1ed794c871
10
Makefile
10
Makefile
@ -1,8 +1,6 @@
|
|||||||
DGDIR=.
|
DGDIR=.
|
||||||
ASCIIDOC_PVE=./asciidoc-pve
|
ASCIIDOC_PVE=./asciidoc-pve
|
||||||
|
|
||||||
include ./pve-doc-generator.mk
|
|
||||||
|
|
||||||
GEN_PACKAGE=pve-doc-generator
|
GEN_PACKAGE=pve-doc-generator
|
||||||
DOC_PACKAGE=pve-docs
|
DOC_PACKAGE=pve-docs
|
||||||
MEDIAWIKI_PACKAGE=pve-docs-mediawiki
|
MEDIAWIKI_PACKAGE=pve-docs-mediawiki
|
||||||
@ -23,7 +21,11 @@ all: index.html
|
|||||||
.pve-doc-depends link-refs.json: $(wildcard *.adoc) scan-adoc-refs
|
.pve-doc-depends link-refs.json: $(wildcard *.adoc) scan-adoc-refs
|
||||||
./scan-adoc-refs *.adoc --depends .pve-doc-depends > link-refs.json
|
./scan-adoc-refs *.adoc --depends .pve-doc-depends > link-refs.json
|
||||||
|
|
||||||
include .pve-doc-depends
|
pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in
|
||||||
|
cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
|
||||||
|
include ./pve-doc-generator.mk
|
||||||
|
|
||||||
GEN_DEB_SOURCES= \
|
GEN_DEB_SOURCES= \
|
||||||
pve-doc-generator.mk \
|
pve-doc-generator.mk \
|
||||||
@ -175,5 +177,5 @@ update: clean
|
|||||||
make all
|
make all
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import
|
rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import .pve-doc-depends pve-doc-generator.mk
|
||||||
find . -name '*~' -exec rm {} ';'
|
find . -name '*~' -exec rm {} ';'
|
||||||
|
|||||||
@ -1,266 +0,0 @@
|
|||||||
# also update debian/changelog
|
|
||||||
DOCRELEASE=4.3
|
|
||||||
|
|
||||||
DGDIR?=/usr/share/pve-doc-generator
|
|
||||||
|
|
||||||
ASCIIDOC_PVE?=/usr/bin/asciidoc-pve
|
|
||||||
|
|
||||||
all:
|
|
||||||
|
|
||||||
PVE_COMMON_DOC_SOURCES= \
|
|
||||||
attributes.txt \
|
|
||||||
pve-copyright.adoc \
|
|
||||||
docinfo.xml
|
|
||||||
|
|
||||||
PVECM_MAN1_SOURCES= \
|
|
||||||
pvecm.adoc \
|
|
||||||
pvecm.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVE_FIREWALL_MAN8_SOURCES= \
|
|
||||||
pve-firewall.adoc \
|
|
||||||
pve-firewall.8-synopsis.adoc \
|
|
||||||
pve-firewall-cluster-opts.adoc \
|
|
||||||
pve-firewall-host-opts.adoc \
|
|
||||||
pve-firewall-vm-opts.adoc \
|
|
||||||
pve-firewall-rules-opts.adoc \
|
|
||||||
pve-firewall-macros.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVESM_MAN1_SOURCES= \
|
|
||||||
pvesm.adoc \
|
|
||||||
pvesm.1-synopsis.adoc \
|
|
||||||
pve-storage-dir.adoc \
|
|
||||||
pve-storage-glusterfs.adoc \
|
|
||||||
pve-storage-iscsi.adoc \
|
|
||||||
pve-storage-iscsidirect.adoc \
|
|
||||||
pve-storage-lvm.adoc \
|
|
||||||
pve-storage-lvmthin.adoc \
|
|
||||||
pve-storage-nfs.adoc \
|
|
||||||
pve-storage-rbd.adoc \
|
|
||||||
pve-storage-zfspool.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
VZDUMP_MAN1_SOURCES= \
|
|
||||||
vzdump.adoc \
|
|
||||||
vzdump.1-synopsis.adoc \
|
|
||||||
vzdump.conf.5-opts.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVESUBSCRIPTION_MAN1_SOURCES= \
|
|
||||||
pvesubscription.adoc \
|
|
||||||
pvesubscription.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVECEPH_MAN1_SOURCES= \
|
|
||||||
pveceph.adoc \
|
|
||||||
pveceph.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PCT_MAN1_SOURCES= \
|
|
||||||
pct.adoc \
|
|
||||||
pct.1-synopsis.adoc \
|
|
||||||
pct.conf.5-opts.adoc \
|
|
||||||
pct-network-opts.adoc \
|
|
||||||
pct-mountpoint-opts.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PCT_CONF_MAN5_SOURCES= \
|
|
||||||
pct.conf.adoc \
|
|
||||||
pct.conf.5-opts.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
DATACENTER_CONF_MAN5_SOURCES= \
|
|
||||||
datacenter.cfg.adoc \
|
|
||||||
datacenter.cfg.5-opts.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
QM_MAN1_SOURCES= \
|
|
||||||
qm.adoc \
|
|
||||||
qm.1-synopsis.adoc \
|
|
||||||
qm.conf.5-opts.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
QM_CONF_MAN5_SOURCES= \
|
|
||||||
qm.conf.adoc \
|
|
||||||
qm.conf.5-opts.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
QMRESTORE_MAN1_SOURCES= \
|
|
||||||
qmrestore.adoc \
|
|
||||||
qmrestore.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVEUM_MAN1_SOURCES= \
|
|
||||||
pveum.adoc \
|
|
||||||
pveum.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVEAM_MAN1_SOURCES= \
|
|
||||||
pveam.adoc \
|
|
||||||
pveam.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
HA_MANAGER_MAN1_SOURCES= \
|
|
||||||
ha-manager.adoc \
|
|
||||||
ha-manager.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVE_HA_CRM_MAN8_SOURCES= \
|
|
||||||
pve-ha-crm.adoc \
|
|
||||||
pve-ha-crm.8-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVE_HA_LRM_MAN8_SOURCES= \
|
|
||||||
pve-ha-lrm.adoc \
|
|
||||||
pve-ha-lrm.8-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVESTATD_MAN8_SOURCES= \
|
|
||||||
pvestatd.adoc \
|
|
||||||
pvestatd.8-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVEDAEMON_MAN8_SOURCES= \
|
|
||||||
pvedaemon.adoc \
|
|
||||||
pvedaemon.8-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVEPROXY_MAN8_SOURCES= \
|
|
||||||
pveproxy.adoc \
|
|
||||||
pveproxy.8-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
SPICEPROXY_MAN8_SOURCES= \
|
|
||||||
spiceproxy.adoc \
|
|
||||||
spiceproxy.8-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PMXCFS_MAN8_SOURCES= \
|
|
||||||
pmxcfs.adoc \
|
|
||||||
pmxcfs.8-cli.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
PVEPERF_MAN1_SOURCES= \
|
|
||||||
pveperf.adoc \
|
|
||||||
pveperf.1-synopsis.adoc \
|
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
|
||||||
|
|
||||||
attributes.txt docinfo.xml:
|
|
||||||
cp ${DGDIR}/$@ $@.tmp
|
|
||||||
mv $@.tmp $@
|
|
||||||
|
|
||||||
%-opts.adoc: ${DGDIR}/gen-%-opts.pl
|
|
||||||
${DGDIR}/gen-$*-opts.pl >$@.tmp
|
|
||||||
mv $@.tmp $@
|
|
||||||
|
|
||||||
%.adoc: ${DGDIR}/gen-%-adoc.pl
|
|
||||||
${DGDIR}/gen-$*-adoc.pl >$@.tmp
|
|
||||||
mv $@.tmp $@
|
|
||||||
|
|
||||||
pveperf.1-synopsis.adoc:
|
|
||||||
echo '*pveperf* `[PATH]`' > pveperf.1-synopsis.adoc
|
|
||||||
|
|
||||||
%.1-synopsis.adoc:
|
|
||||||
perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
|
|
||||||
mv $@.tmp $@
|
|
||||||
|
|
||||||
%.8-synopsis.adoc:
|
|
||||||
perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
|
|
||||||
mv $@.tmp $@
|
|
||||||
|
|
||||||
ifneq (${DGDIR},.)
|
|
||||||
%.adoc: ${DGDIR}/%.adoc
|
|
||||||
cp $< $@.tmp
|
|
||||||
mv $@.tmp $@
|
|
||||||
endif
|
|
||||||
|
|
||||||
pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pve-firewall.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pvesm.1: ${PVESM_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pvesm.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pveceph.1: ${PVECEPH_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pveceph.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pct.1: ${PCT_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pct.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
vzdump.1: ${VZDUMP_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ vzdump.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pvesubscription.1: ${PVESUBSCRIPTION_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pvesubscription.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
qm.1: ${QM_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ qm.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
qmrestore.1: ${QMRESTORE_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ qmrestore.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pvecm.1: ${PVECM_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pvecm.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pveum.1: ${PVEUM_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pveum.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pveam.1: ${PVEAM_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pveam.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
ha-manager.1: ${HA_MANAGER_MAN1_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ ha-manager.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pve-ha-crm.8: ${PVE_HA_CRM_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pve-ha-crm.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pve-ha-lrm.8: ${PVE_HA_LRM_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pve-ha-lrm.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pvestatd.8: ${PVESTATD_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pvestatd.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pvedaemon.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pveproxy.8: ${PVEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pveproxy.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
spiceproxy.8: ${SPICEPROXY_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ spiceproxy.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
pmxcfs.8: ${PMXCFS_MAN8_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ pmxcfs.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
qm.conf.5: ${QM_CONF_MAN5_SOURCES}
|
|
||||||
|
|
||||||
pct.conf.5: ${PCT_CONF_MAN5_SOURCES}
|
|
||||||
|
|
||||||
datacenter.cfg.5: ${DATACENTER_CONF_MAN5_SOURCES}
|
|
||||||
|
|
||||||
%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} ${ASCIIDOC_PVE}
|
|
||||||
${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
|
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
|
||||||
|
|
||||||
.PHONY: cleanup-docgen
|
|
||||||
cleanup-docgen:
|
|
||||||
rm -f *.tmp.xml *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
|
|
||||||
79
pve-doc-generator.mk.in
Normal file
79
pve-doc-generator.mk.in
Normal file
@ -0,0 +1,79 @@
|
|||||||
|
# also update debian/changelog
|
||||||
|
DOCRELEASE=4.3
|
||||||
|
|
||||||
|
DGDIR?=/usr/share/pve-doc-generator
|
||||||
|
|
||||||
|
ASCIIDOC_PVE?=/usr/bin/asciidoc-pve
|
||||||
|
|
||||||
|
PVE_COMMON_DOC_SOURCES= \
|
||||||
|
${ASCIIDOC_PVE} \
|
||||||
|
attributes.txt \
|
||||||
|
pve-copyright.adoc \
|
||||||
|
docinfo.xml
|
||||||
|
|
||||||
|
all:
|
||||||
|
|
||||||
|
attributes.txt docinfo.xml:
|
||||||
|
cp ${DGDIR}/$@ $@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
|
||||||
|
%-opts.adoc: ${DGDIR}/gen-%-opts.pl
|
||||||
|
${DGDIR}/gen-$*-opts.pl >$@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
|
||||||
|
%.adoc: ${DGDIR}/gen-%-adoc.pl
|
||||||
|
${DGDIR}/gen-$*-adoc.pl >$@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
|
||||||
|
pveperf.1-synopsis.adoc:
|
||||||
|
echo '*pveperf* `[PATH]`' > pveperf.1-synopsis.adoc
|
||||||
|
|
||||||
|
%.1-synopsis.adoc:
|
||||||
|
perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
|
||||||
|
%.8-synopsis.adoc:
|
||||||
|
perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsis();" > $@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
|
||||||
|
ifneq (${DGDIR},.)
|
||||||
|
%.adoc: ${DGDIR}/%.adoc
|
||||||
|
cp $< $@.tmp
|
||||||
|
mv $@.tmp $@
|
||||||
|
endif
|
||||||
|
|
||||||
|
|
||||||
|
%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-wiki -o $@ $*.adoc
|
||||||
|
|
||||||
|
chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-chapter -o $@ $*.adoc
|
||||||
|
|
||||||
|
%.1: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
|
||||||
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
|
%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man-html -o $@ $*.adoc
|
||||||
|
|
||||||
|
%.8: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
|
||||||
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
|
%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man-html -o $@ $*.adoc
|
||||||
|
|
||||||
|
%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man -o $@ $*.adoc
|
||||||
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
|
%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man-html -o $@ $*.adoc
|
||||||
|
|
||||||
|
%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
|
||||||
|
${ASCIIDOC_PVE} compile-man-wiki -o $@ $*.adoc
|
||||||
|
|
||||||
|
|
||||||
|
.PHONY: cleanup-docgen
|
||||||
|
cleanup-docgen:
|
||||||
|
rm -f *.xml.tmp *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
|
||||||
Loading…
Reference in New Issue
Block a user