X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=dd9d172c72976532b506372ea0ee92fd907904c9;hp=314671200bc18df5135d2a578e9895912154bc72;hb=96f2beeb13548b0a3f86b62548809cea3be488c3;hpb=9344ee0d0b9d50e93bbd62f8eeae1406d29a8e44 diff --git a/Makefile b/Makefile index 3146712..dd9d172 100644 --- a/Makefile +++ b/Makefile @@ -1,86 +1,102 @@ -RELEASE=4.1 +DGDIR=. + +include ./pve-doc-generator.mk 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 \ +GITVERSION:=$(shell cat .git/refs/heads/master) + +DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb + +COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager + +SERVICE_LIST= \ + pve-firewall \ + pve-ha-crm \ + pve-ha-lrm \ + pvestatd \ + pmxcfs \ + pveproxy \ + pvedaemon + +CONFIG_LIST=datacenter.cfg qm.conf pct.conf + +DEB_SOURCES= \ + pve-doc-generator.mk \ + attributes.txt \ + $(addsuffix .adoc, ${COMMAND_LIST}) \ + $(addsuffix .adoc, ${SERVICE_LIST}) \ + $(addsuffix .adoc, ${CONFIG_LIST}) \ + pve-storage-dir.adoc \ + pve-storage-glusterfs.adoc \ + pve-storage-iscsi.adoc \ + pve-storage-iscsidirect.adoc \ + pve-storage-lvm.adoc \ + pve-storage-nfs.adoc \ + pve-storage-rbd.adoc \ + pve-storage-zfspool.adoc \ + pmxcfs.8-cli.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-qm.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 -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 -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= \ - getting-help.adoc \ - pve-package-repos.adoc \ - pve-installation.adoc \ - system-software-updates.adoc \ +SYSADMIN_SOURCES= \ + getting-help.adoc \ + pve-package-repos.adoc \ + pve-installation.adoc \ + system-software-updates.adoc \ 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} \ - ${PVEAM_SOURCES} \ - ${PVEUM_SOURCES} \ - ${PVESM_SOURCES} \ - ${VZDUMP_SOURCES} \ - ${HA_SOURCES} \ - images/cluster-nwdiag.svg \ - images/node-nwdiag.svg \ - pve-bibliography.adoc \ - GFDL.adoc \ +PVE_ADMIN_GUIDE_SOURCES= \ + ${DATACENTER_CONF_MAN5_SOURCES} \ + ${QM_CONF_MAN5_SOURCES} \ + ${PCT_CONF_MAN5_SOURCES} \ + ${SYSADMIN_SOURCES} \ + pve-admin-guide.adoc \ + pve-intro.adoc \ + pmxcfs.adoc \ + pmxcfs.8-cli.adoc \ + pve-faq.adoc \ + ${PVE_FIREWALL_MAN8_SOURCES} \ + ${PVESM_MAN1_SOURCES} \ + ${PCT_MAN1_SOURCES} \ + ${PVECM_MAN1_SOURCES} \ + ${PVEUM_MAN1_SOURCES} \ + ${QM_MAN1_SOURCES} \ + ${QMRESTORE_MAN1_SOURCES} \ + ${HA_MANAGER_MAN1_SOURCES} \ + ${PVE_HA_CRM_MAN8_SOURCES} \ + ${PVE_HA_LRM_MAN8_SOURCES} \ + ${PVEAM_SOURCES} \ + ${VZDUMP_SOURCES} \ + images/cluster-nwdiag.svg \ + images/node-nwdiag.svg \ + pve-bibliography.adoc \ + $(addsuffix .adoc, ${COMMAND_LIST}) \ + $(addsuffix .adoc, ${SERVICE_LIST}) \ + $(addsuffix .adoc, ${CONFIG_LIST}) \ + GFDL.adoc \ attributes.txt 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}" +ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}" +ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}" +ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}" BROWSER?=xdg-open @@ -89,51 +105,35 @@ all: pve-admin-guide.html %-nwdiag.svg: %.nwdiag nwdiag -T svg $*.nwdiag -o $@; -%.1-synopsis.adoc: - perl -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp - mv $@.tmp $@ - -%.1: %.adoc %.1-synopsis.adoc docinfo.xml - a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc - test -n "$${NOVIEW}" || man -l $@ - -%.1.html: %.adoc %.1-synopsis.adoc docinfo.xml +%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc test -n "$${NOVIEW}" || $(BROWSER) $@ & -%.8-synopsis.adoc: - perl -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp - mv $@.tmp $@ - -%.8: %.adoc %.8-synopsis.adoc docinfo.xml - a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${RELEASE}" -f manpage $*.adoc - test -n "$${NOVIEW}" || man -l $@ +pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES} + asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc + test -n "$${NOVIEW}" || $(BROWSER) $@ & -%.8.html: %.adoc %.8-synopsis.adoc docinfo.xml +%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} 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 ${RELEASE}" -f manpage $*.adoc - test -n "$${NOVIEW}" || man -l $@ - -%.5.html: %.adoc %.5-opts.adoc docinfo.xml +%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} 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 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 + $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST}) + asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" 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 + asciidoc -a "revnumber=${DOCRELEASE}" -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); + grep ">Release ${DOCRELEASE}<" 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 -n "$${NOVIEW}" || $(BROWSER) $@ & @@ -151,11 +151,22 @@ ${DEB} deb: mkdir build rsync -a debian/ build/debian mkdir -p build/usr/share/${PACKAGE} + mkdir -p build/usr/share/doc/${PACKAGE} + echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${PACKAGE}/SOURCE 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} +.PHONY: upload +upload: ${DEB} + umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw + mkdir -p /pve/${DOCRELEASE}/extra + rm -f /pve/${DOCRELEASE}/extra/${PACKAGE}_*.deb + rm -f /pve/${DOCRELEASE}/extra/Packages* + cp ${DEB} /pve/${DOCRELEASE}/extra + cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz + umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro update: clean rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc