RELEASE=4.1
+PACKAGE=pve-doc-generator
+
+# also update debian/changelog
+PKGREL=1
+
+DEB=${PACKAGE}_${RELEASE}-${PKGREL}_amd64.deb
+
+DGDIR=.
+
+include ./pve-doc-generator.mk
+
+
+DEB_SOURCES= \
+ pve-doc-generator.mk \
+ attributes.txt \
+ pvesm.adoc \
+ pveum.adoc \
+ vzdump.adoc \
+ pve-firewall.adoc \
+ qm.adoc \
+ pct.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-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
+
PVESM_SOURCES=attributes.txt pvesm.adoc pvesm.1-synopsis.adoc $(shell ls pve-storage-*.adoc)
PVEUM_SOURCES=attributes.txt pveum.adoc pveum.1-synopsis.adoc
VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
-PVEFW_SOURCES=attributes.txt pve-firewall.adoc pve-firewall-rules-opts.adoc pve-firewall-cluster-opts.adoc pve-firewall-host-opts.adoc pve-firewall-vm-opts.adoc pve-firewall-macros.adoc pve-firewall.8-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
pve-intro.adoc \
pmxcfs.adoc \
pve-faq.adoc \
+ ${PVE_FIREWALL_MAN8_SOURCES} \
${QM_SOURCES} \
${PCT_SOURCES} \
${PVEAM_SOURCES} \
- ${PVEFW_SOURCES} \
${PVEUM_SOURCES} \
${PVESM_SOURCES} \
${VZDUMP_SOURCES} \
%.1: %.adoc %.1-synopsis.adoc docinfo.xml
a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc
- test -z "$${NOVIEW}" && man -l $@
+ test -n "$${NOVIEW}" || man -l $@
%.1.html: %.adoc %.1-synopsis.adoc docinfo.xml
asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
- test -z "$${NOVIEW}" && $(BROWSER) $@ &
+ test -n "$${NOVIEW}" || $(BROWSER) $@ &
%.8-synopsis.adoc:
%.8: %.adoc %.8-synopsis.adoc docinfo.xml
a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc
- test -z "$${NOVIEW}" && man -l $@
+ test -n "$${NOVIEW}" || man -l $@
%.8.html: %.adoc %.8-synopsis.adoc docinfo.xml
asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
- test -z "$${NOVIEW}" && $(BROWSER) $@ &
-
-pve-firewall-cluster-opts.adoc:
- ./gen-pve-firewall-cluster-opts.pl >$@.tmp
- mv $@.tmp $@
-
-pve-firewall-host-opts.adoc:
- ./gen-pve-firewall-host-opts.pl >$@.tmp
- mv $@.tmp $@
-
-pve-firewall-vm-opts.adoc:
- ./gen-pve-firewall-vm-opts.pl >$@.tmp
- mv $@.tmp $@
-
-pve-firewall-rules-opts.adoc:
- ./gen-pve-firewall-rules-opts-adoc.pl >$@.tmp
- mv $@.tmp $@
-
-pve-firewall-macros.adoc:
- ./gen-pve-firewall-macros-adoc.pl >$@.tmp
- mv $@.tmp $@
-
-datacenter.cfg.5-opts.adoc:
- ./gen-datacenter-cfg-opts-adoc.pl >$@.tmp
- mv $@.tmp $@
-
-vm.conf.5-opts.adoc:
- ./gen-vm-conf-opts-adoc.pl >$@.tmp
- mv $@.tmp $@
-
-pct.conf.5-opts.adoc:
- ./gen-pct-conf-opts-adoc.pl >$@.tmp
- mv $@.tmp $@
+ test -n "$${NOVIEW}" || $(BROWSER) $@ &
%.5: %.adoc %.5-opts.adoc docinfo.xml
a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc
- test -z "$${NOVIEW}" && man -l $@
+ test -n "$${NOVIEW}" || man -l $@
%.5.html: %.adoc %.5-opts.adoc docinfo.xml
asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
- test -z "$${NOVIEW}" && $(BROWSER) $@ &
+ test -n "$${NOVIEW}" || $(BROWSER) $@ &
index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES}
$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
$(MAKE) NOVIEW=1 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html
asciidoc -a "date=$(shell date)" -a "revnumber=${RELEASE}" index.adoc
- $(BROWSER) index.html &
+ test -n "$${NOVIEW}" || $(BROWSER) index.html &
pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
asciidoc -a "revnumber=${RELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
- test -z "$${NOVIEW}" && $(BROWSER) $@ &
+ test -n "$${NOVIEW}" || $(BROWSER) $@ &
pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
grep ">Release ${RELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" --dblatex-opts "-P doc.section.depth=2 -P toc.section.depth=2" pve-admin-guide.adoc
- test -z "$${NOVIEW}" && $(BROWSER) $@ &
+ test -n "$${NOVIEW}" || $(BROWSER) $@ &
pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
a2x -f epub pve-admin-guide.adoc
- test -z "$${NOVIEW}" && $(BROWSER) $@ &
+ test -n "$${NOVIEW}" || $(BROWSER) $@ &
+
+.PHONY: dinstall
+dinstall: ${DEB}
+ dpkg -i ${DEB}
+
+.PHONY: deb
+${DEB} deb:
+ rm -rf build
+ mkdir build
+ rsync -a debian/ build/debian
+ mkdir -p build/usr/share/${PACKAGE}
+ install -m 0644 ${DEB_SOURCES} build/usr/share/${PACKAGE}
+ install -m 0755 ${GEN_SCRIPTS} build/usr/share/${PACKAGE}
+ cd build; dpkg-buildpackage -rfakeroot -b -us -uc
+ lintian ${DEB}
+
update: clean
rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
make all
clean:
- rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8
+ rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build
+
--- /dev/null
+Coryright for files in debian/* and all perl files (*.pl):
+
+ Copyright (C) 2015 Proxmox Server Solutions GmbH
+
+ This software is written by Proxmox Server Solutions GmbH
+ <support@proxmox.com>
+
+ This program is free software: you can redistribute it and/or
+ modify it under the terms of the GNU Affero General Public License
+ as published by the Free Software Foundation, either version 3 of
+ the License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public
+ License along with this program. If not, see
+ <http://www.gnu.org/licenses/>.
+
+
+All documentation files (*.adoc) are release under:
+
+ Copyright (C) 2015 Proxmox Server Solutions GmbH
+
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.3
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+ A copy of the license is included in the section entitled "GNU
+ Free Documentation License".
+
+ You can find a copy of the license in /usr/share/common-licenses/GFDL.
\ No newline at end of file
--- /dev/null
+DGDIR?=/usr/share/pve-doc-generator
+
+all:
+
+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 \
+ attributes.txt \
+ docinfo.xml
+
+attributes.txt docinfo.xml:
+ cp ${DGDIR}/$@ $@.tmp
+ mv $@.tmp $@
+
+%-opts.adoc: ${DGDIR}/gen-%-opts.pl
+ $< >$@.tmp
+ mv $@.tmp $@
+
+%.adoc: ${DGDIR}/gen-%-adoc.pl
+ $< >$@.tmp
+ mv $@.tmp $@
+
+%.1-synopsis.adoc:
+ perl -I. -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
+ mv $@.tmp $@
+
+%.8-synopsis.adoc:
+ perl -I. -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
+ mv $@.tmp $@
+
+%.adoc: ${DGDIR}/%.adoc
+ cp $< $@.tmp
+ mv $@.tmp $@
+
+pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
+ a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${RELEASE}" -f manpage pve-firewall.adoc
+ test -n "$${NOVIEW}" || man -l $@
+
+
+.PHONY: cleanup-docgen
+cleanup-docgen:
+ rm -f *.1 *.8 *.adoc attributes.txt docinfo.xml