From 9344ee0d0b9d50e93bbd62f8eeae1406d29a8e44 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 6 Apr 2016 09:38:55 +0200 Subject: [PATCH] create debian package with all sources to generate pve manual pages --- Makefile | 110 +++++++++++------- debian/changelog | 6 + debian/compat | 1 + debian/control | 14 +++ debian/copyright | 34 ++++++ debian/install | 1 + debian/rules | 7 ++ gen-datacenter-cfg-opts-adoc.pl | 1 + gen-pct-conf-opts-adoc.pl | 1 + gen-pve-firewall-cluster-opts.pl | 1 + gen-pve-firewall-host-opts.pl | 1 + gen-pve-firewall-macros-adoc.pl | 1 + ...-adoc.pl => gen-pve-firewall-rules-opts.pl | 1 + gen-pve-firewall-vm-opts.pl | 1 + gen-vm-conf-opts-adoc.pl | 1 + pve-doc-generator.mk | 47 ++++++++ 16 files changed, 183 insertions(+), 45 deletions(-) create mode 100644 debian/changelog create mode 100644 debian/compat create mode 100644 debian/control create mode 100644 debian/copyright create mode 100644 debian/install create mode 100755 debian/rules rename gen-pve-firewall-rules-opts-adoc.pl => gen-pve-firewall-rules-opts.pl (97%) create mode 100644 pve-doc-generator.mk diff --git a/Makefile b/Makefile index 2fb88d2..3146712 100644 --- a/Makefile +++ b/Makefile @@ -1,9 +1,44 @@ 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 @@ -28,10 +63,10 @@ PVE_ADMIN_GUIDE_SOURCES= \ 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} \ @@ -60,11 +95,11 @@ all: pve-admin-guide.html %.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: @@ -73,74 +108,59 @@ all: pve-admin-guide.html %.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 + diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..64f8d55 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,6 @@ +pve-doc-generator (4.1-1) unstable; urgency=medium + + * first release + + -- Proxmox Support Team Tue, 05 Apr 2016 18:02:59 +0200 + diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..ec63514 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +9 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..7670e72 --- /dev/null +++ b/debian/control @@ -0,0 +1,14 @@ +Source: pve-doc-generator +Section: perl +Priority: extra +Maintainer: Proxmox Support Team +Build-Depends: debhelper (>= 7.0.50~), lintian +Standards-Version: 3.8.4 + +Package: pve-doc-generator +Section: perl +Priority: optional +Architecture: any +Depends: pve-manager +Description: Proxmox VE Documentation helpers + Tool to auto-generate various Proxmox VE Documentation files. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..dc03a71 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,34 @@ +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 + + + 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 + . + + +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 diff --git a/debian/install b/debian/install new file mode 100644 index 0000000..1412e51 --- /dev/null +++ b/debian/install @@ -0,0 +1 @@ +/usr/share/ diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..736b14e --- /dev/null +++ b/debian/rules @@ -0,0 +1,7 @@ +#!/usr/bin/make -f + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + +%: + dh $@ diff --git a/gen-datacenter-cfg-opts-adoc.pl b/gen-datacenter-cfg-opts-adoc.pl index bc396b4..1c687c9 100755 --- a/gen-datacenter-cfg-opts-adoc.pl +++ b/gen-datacenter-cfg-opts-adoc.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; use PVE::Cluster; diff --git a/gen-pct-conf-opts-adoc.pl b/gen-pct-conf-opts-adoc.pl index 2191d37..d6744fa 100755 --- a/gen-pct-conf-opts-adoc.pl +++ b/gen-pct-conf-opts-adoc.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; use PVE::RESTHandler; diff --git a/gen-pve-firewall-cluster-opts.pl b/gen-pve-firewall-cluster-opts.pl index 2d4a04c..31344f5 100755 --- a/gen-pve-firewall-cluster-opts.pl +++ b/gen-pve-firewall-cluster-opts.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; diff --git a/gen-pve-firewall-host-opts.pl b/gen-pve-firewall-host-opts.pl index 6ca2e7f..0af6b96 100755 --- a/gen-pve-firewall-host-opts.pl +++ b/gen-pve-firewall-host-opts.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; diff --git a/gen-pve-firewall-macros-adoc.pl b/gen-pve-firewall-macros-adoc.pl index 9137d1f..8448a28 100755 --- a/gen-pve-firewall-macros-adoc.pl +++ b/gen-pve-firewall-macros-adoc.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; diff --git a/gen-pve-firewall-rules-opts-adoc.pl b/gen-pve-firewall-rules-opts.pl similarity index 97% rename from gen-pve-firewall-rules-opts-adoc.pl rename to gen-pve-firewall-rules-opts.pl index ef3b09c..622994c 100755 --- a/gen-pve-firewall-rules-opts-adoc.pl +++ b/gen-pve-firewall-rules-opts.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; diff --git a/gen-pve-firewall-vm-opts.pl b/gen-pve-firewall-vm-opts.pl index 651c10e..35d1e9f 100755 --- a/gen-pve-firewall-vm-opts.pl +++ b/gen-pve-firewall-vm-opts.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; diff --git a/gen-vm-conf-opts-adoc.pl b/gen-vm-conf-opts-adoc.pl index 8aadf92..cb62d13 100755 --- a/gen-vm-conf-opts-adoc.pl +++ b/gen-vm-conf-opts-adoc.pl @@ -1,5 +1,6 @@ #!/usr/bin/perl +use lib '.'; use strict; use warnings; use PVE::RESTHandler; diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk new file mode 100644 index 0000000..be8a62f --- /dev/null +++ b/pve-doc-generator.mk @@ -0,0 +1,47 @@ +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 -- 2.39.2