Browse Source

export pct.1 pct.conf.5 vm.conf.5 and datacenter.conf.5

stable-4
Dietmar Maurer 3 years ago
parent
commit
f6b81378f1
5 changed files with 32 additions and 12 deletions
  1. 8
    10
      Makefile
  2. 0
    0
      gen-datacenter.cfg.5-opts.pl
  3. 0
    0
      gen-pct.conf.5-opts.pl
  4. 0
    0
      gen-vm.conf.5-opts.pl
  5. 24
    2
      pve-doc-generator.mk

+ 8
- 10
Makefile View File

@@ -26,26 +26,28 @@ DEB_SOURCES= \
vzdump.adoc \
pve-firewall.adoc \
qm.adoc \
vm.conf.adoc \
pct.adoc \
pct.conf.adoc \
datacenter.cfg.adoc \
pveam.adoc \
ha-manager.adoc \
pve-copyright.adoc \
docinfo.xml

GEN_SCRIPTS= \
gen-datacenter-cfg-opts-adoc.pl \
gen-pct-conf-opts-adoc.pl \
gen-datacenter.cfg.5-opts.pl \
gen-pct.conf.5-opts.pl \
gen-vm.conf.5-opts.pl \
gen-pve-firewall-cluster-opts.pl \
gen-pve-firewall-host-opts.pl \
gen-pve-firewall-macros-adoc.pl \
gen-pve-firewall-rules-opts.pl \
gen-pve-firewall-vm-opts.pl \
gen-vm-conf-opts-adoc.pl
gen-pve-firewall-vm-opts.pl

PVEUM_SOURCES=attributes.txt pveum.adoc pveum.1-synopsis.adoc
VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
QM_SOURCES=attributes.txt qm.adoc qm.1-synopsis.adoc
PCT_SOURCES=attributes.txt pct.adoc pct.1-synopsis.adoc
PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc
HA_SOURCES=attributes.txt ha-manager.1-synopsis.adoc ha-manager.adoc

@@ -70,8 +72,8 @@ PVE_ADMIN_GUIDE_SOURCES= \
pve-faq.adoc \
${PVE_FIREWALL_MAN8_SOURCES} \
${PVESM_MAN1_SOURCES} \
${PCT_MAN1_SOURCES} \
${QM_SOURCES} \
${PCT_SOURCES} \
${PVEAM_SOURCES} \
${PVEUM_SOURCES} \
${VZDUMP_SOURCES} \
@@ -115,10 +117,6 @@ all: pve-admin-guide.html
asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ &

%.5: %.adoc %.5-opts.adoc docinfo.xml
a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
test -n "$${NOVIEW}" || man -l $@

%.5.html: %.adoc %.5-opts.adoc docinfo.xml
asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
test -n "$${NOVIEW}" || $(BROWSER) $@ &

gen-datacenter-cfg-opts-adoc.pl → gen-datacenter.cfg.5-opts.pl View File


gen-pct-conf-opts-adoc.pl → gen-pct.conf.5-opts.pl View File


gen-vm-conf-opts-adoc.pl → gen-vm.conf.5-opts.pl View File


+ 24
- 2
pve-doc-generator.mk View File

@@ -33,16 +33,21 @@ PVESM_MAN1_SOURCES= \
pve-storage-zfspool.adoc \
${PVE_COMMON_DOC_SOURCES}

PCT_MAN1_SOURCES= \
pct.adoc \
pct.1-synopsis.adoc \
${PVE_COMMON_DOC_SOURCES}

attributes.txt docinfo.xml:
cp ${DGDIR}/$@ $@.tmp
mv $@.tmp $@

%-opts.adoc: ${DGDIR}/gen-%-opts.pl
$< >$@.tmp
${DGDIR}/gen-$*-opts.pl >$@.tmp
mv $@.tmp $@

%.adoc: ${DGDIR}/gen-%-adoc.pl
$< >$@.tmp
${DGDIR}/gen-$*-adoc.pl >$@.tmp
mv $@.tmp $@

%.1-synopsis.adoc:
@@ -53,9 +58,11 @@ attributes.txt docinfo.xml:
perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
mv $@.tmp $@

ifneq (${DGDIR},.)
%.adoc: ${DGDIR}/%.adoc
cp $< $@.tmp
mv $@.tmp $@
endif

pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-firewall.adoc
@@ -65,6 +72,21 @@ pvesm.1: ${PVESM_MAN1_SOURCES}
a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvesm.adoc
test -n "$${NOVIEW}" || man -l $@

pct.1: ${PCT_MAN1_SOURCES}
a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pct.adoc
test -n "$${NOVIEW}" || man -l $@

pct.conf.5: pct.conf.adoc pct.conf.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage pct.conf.adoc
test -n "$${NOVIEW}" || man -l $@

vm.conf.5: vm.conf.adoc vm.conf.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage vm.conf.adoc
test -n "$${NOVIEW}" || man -l $@

datacenter.conf.5: datacenter.conf.adoc datacenter.conf.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage datacenter.conf.adoc
test -n "$${NOVIEW}" || man -l $@

.PHONY: cleanup-docgen
cleanup-docgen:

Loading…
Cancel
Save