X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=9d6d6fa10f625804457b6f3efbc6881ca6ec4382;hp=1ccca2dbfcf79a704f16029d5dfe77472cd1be7f;hb=2d8f1c9267103ca279abcde3e8413866020ae323;hpb=deb7f2ea7d353690048b9799f30792ff95075fac diff --git a/Makefile b/Makefile index 1ccca2d..9d6d6fa 100644 --- a/Makefile +++ b/Makefile @@ -1,82 +1,182 @@ +DGDIR=. + +include ./pve-doc-generator.mk + +PACKAGE=pve-doc-generator + +# also update debian/changelog +PKGREL=1 + +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 \ + spiceproxy \ + 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.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 - -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 - -PVE_ADMIN_GUIDE_SOURCES= \ - sysadmin.adoc \ - pve-admin-guide.adoc \ - pve-intro.adoc \ - pmxcfs.adoc \ - pve-faq.adoc \ - ${QM_SOURCES} \ - ${PCT_SOURCES} \ - ${PVEFW_SOURCES} \ - ${PVEUM_SOURCES} \ - ${PVESM_SOURCES} \ - ${VZDUMP_SOURCES} \ - images/cluster-nwdiag.svg \ - images/node-nwdiag.svg \ - pve-bibliography.adoc \ +PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc + +SYSADMIN_SOURCES= \ + getting-help.adoc \ + pve-package-repos.adoc \ + pve-installation.adoc \ + system-software-updates.adoc \ + sysadmin.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} \ + ${PVESTATD_MAN8_SOURCES} \ + ${PVEDAEMON_MAN8_SOURCES} \ + ${PVEPROXY_MAN8_SOURCES} \ + ${SPICEPROXY_MAN8_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} -ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} +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}" -%-nwdiag.svg: %.nwdiag - nwdiag -T svg $*.nwdiag -o $@; +BROWSER?=xdg-open -%.1-synopsis.adoc: - perl -e "use PVE::CLI::$(subst -,_,$*);print PVE::CLI::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp - mv $@.tmp $@ +all: pve-admin-guide.html -%.1: %.adoc %.1-synopsis.adoc docinfo.xml - a2x -a docinfo1 -a "manvolnum=1" -f manpage $*.adoc - test -z "$${NOVIEW}" && man -l $@ +%-nwdiag.svg: %.nwdiag + nwdiag -T svg $*.nwdiag -o $@; -%.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 -z "$${NOVIEW}" && iceweasel $@ & + test -n "$${NOVIEW}" || $(BROWSER) $@ & -%.8-synopsis.adoc: - perl -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp - mv $@.tmp $@ +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: %.adoc %.8-synopsis.adoc docinfo.xml - a2x -a docinfo1 -a "manvolnum=1" -f manpage $*.adoc - test -z "$${NOVIEW}" && man -l $@ - -%.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 -z "$${NOVIEW}" && iceweasel $@ & - + test -n "$${NOVIEW}" || $(BROWSER) $@ & -all: pve-admin-guide.html +%.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 pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html - asciidoc -a "date=$(shell date)" index.adoc - iceweasel index.html & + $(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 "date=$(shell date)" pve-admin-guide.adoc - test -z "$${NOVIEW}" && iceweasel $@ & + 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 - a2x -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" pve-admin-guide.adoc - test -z "$${NOVIEW}" && iceweasel $@ & +pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml + 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) $@ & pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES} a2x -f epub pve-admin-guide.adoc - test -z "$${NOVIEW}" && iceweasel $@ & - + 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} + 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 + make all clean: - rm -rf *~ *.html *.pdf *.epub *.1 *.8 + rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build +