]> git.proxmox.com Git - pve-docs.git/blobdiff - Makefile
create debian package with all sources to generate pve manual pages
[pve-docs.git] / Makefile
index 30eb5db034241f6b43b652a6ac513622f373e185..314671200bc18df5135d2a578e9895912154bc72 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,11 +1,47 @@
 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.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
 HA_SOURCES=attributes.txt ha-manager.1-synopsis.adoc ha-manager.adoc
 
 SYSADMIN_SOURCES=                      \
@@ -16,14 +52,21 @@ SYSADMIN_SOURCES=                   \
        sysadmin.adoc
 
 PVE_ADMIN_GUIDE_SOURCES=               \
+       datacenter.cfg.adoc             \
+       datacenter.cfg.5-opts.adoc      \
+       vm.conf.adoc                    \
+       vm.conf.5-opts.adoc             \
+       pct.conf.adoc                   \
+       pct.conf.5-opts.adoc            \
        ${SYSADMIN_SOURCES}             \
        pve-admin-guide.adoc            \
        pve-intro.adoc                  \
        pmxcfs.adoc                     \
        pve-faq.adoc                    \
+       ${PVE_FIREWALL_MAN8_SOURCES}    \
        ${QM_SOURCES}                   \
        ${PCT_SOURCES}                  \
-       ${PVEFW_SOURCES}                \
+       ${PVEAM_SOURCES}                \
        ${PVEUM_SOURCES}                \
        ${PVESM_SOURCES}                \
        ${VZDUMP_SOURCES}               \
@@ -36,10 +79,13 @@ PVE_ADMIN_GUIDE_SOURCES=            \
 
 ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)"
 ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${RELEASE}"
+ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${RELEASE}"
 ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${RELEASE}"
 
 BROWSER?=xdg-open
 
+all: pve-admin-guide.html
+
 %-nwdiag.svg: %.nwdiag
        nwdiag -T svg $*.nwdiag -o $@;
 
@@ -49,11 +95,11 @@ BROWSER?=xdg-open
 
 %.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:
@@ -62,34 +108,59 @@ BROWSER?=xdg-open
 
 %.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) $@ &
+       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 -n "$${NOVIEW}" || man -l $@
 
-all: pve-admin-guide.html
+%.5.html: %.adoc %.5-opts.adoc docinfo.xml
+       asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
+       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 pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html
-       asciidoc -a "date=$(shell date)" -a "revnumber=${RELEASE}" index.adoc 
-       $(BROWSER) index.html &
+       $(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
+       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) $@ &
+       asciidoc -a "revnumber=${RELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
+       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" pve-admin-guide.adoc
-       test -z "$${NOVIEW}" && $(BROWSER) $@ &
+       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 -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 *.1 *.8
+       rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build
+