X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=52b7e0fb42f44996ad173df6e081b3fad22da958;hp=9d6d6fa10f625804457b6f3efbc6881ca6ec4382;hb=5bee3225b63f863e16990dd28ad47b40c5a42293;hpb=2d8f1c9267103ca279abcde3e8413866020ae323 diff --git a/Makefile b/Makefile index 9d6d6fa..52b7e0f 100644 --- a/Makefile +++ b/Makefile @@ -2,16 +2,31 @@ DGDIR=. include ./pve-doc-generator.mk -PACKAGE=pve-doc-generator +GEN_PACKAGE=pve-doc-generator +DOC_PACKAGE=pve-docs # also update debian/changelog -PKGREL=1 +GEN_PKGREL=1 +# also update doc-debian/changelog +DOC_PKGREL=2 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 +GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${GEN_PKGREL}_amd64.deb +DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${DOC_PKGREL}_all.deb + +COMMAND_LIST= \ + pvesubscription \ + pvecm \ + qm \ + qmrestore \ + pveceph \ + pct \ + pveam \ + pvesm \ + pveum \ + vzdump \ + ha-manager SERVICE_LIST= \ pve-firewall \ @@ -25,7 +40,7 @@ SERVICE_LIST= \ CONFIG_LIST=datacenter.cfg qm.conf pct.conf -DEB_SOURCES= \ +GEN_DEB_SOURCES= \ pve-doc-generator.mk \ attributes.txt \ $(addsuffix .adoc, ${COMMAND_LIST}) \ @@ -47,15 +62,13 @@ GEN_SCRIPTS= \ gen-datacenter.cfg.5-opts.pl \ gen-pct.conf.5-opts.pl \ gen-qm.conf.5-opts.pl \ + gen-vzdump.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 -VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc -PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc - SYSADMIN_SOURCES= \ getting-help.adoc \ pve-package-repos.adoc \ @@ -63,6 +76,10 @@ SYSADMIN_SOURCES= \ system-software-updates.adoc \ sysadmin.adoc +API_VIEWER_SOURCES= \ + api-viewer/index.html \ + api-viewer/apidoc.js + PVE_ADMIN_GUIDE_SOURCES= \ ${DATACENTER_CONF_MAN5_SOURCES} \ ${QM_CONF_MAN5_SOURCES} \ @@ -87,8 +104,10 @@ PVE_ADMIN_GUIDE_SOURCES= \ ${SPICEPROXY_MAN8_SOURCES} \ ${PVE_HA_CRM_MAN8_SOURCES} \ ${PVE_HA_LRM_MAN8_SOURCES} \ - ${PVEAM_SOURCES} \ - ${VZDUMP_SOURCES} \ + ${VZDUMP_MAN1_SOURCES} \ + ${PVEAM_MAN1_SOURCES} \ + ${PVESUBSCRIPTION_MAN1_SOURCES} \ + ${PVECEPH_MAN1_SOURCES} \ images/cluster-nwdiag.svg \ images/node-nwdiag.svg \ pve-bibliography.adoc \ @@ -127,7 +146,7 @@ pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES} asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc test -n "$${NOVIEW}" || $(BROWSER) $@ & -index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} +index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES} $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub $(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 @@ -146,30 +165,70 @@ pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES} a2x -f epub pve-admin-guide.adoc test -n "$${NOVIEW}" || $(BROWSER) $@ & +api-viewer/apidata.js: extractapi.pl + ./extractapi.pl >$@ + +api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js + cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@ + .PHONY: dinstall -dinstall: ${DEB} - dpkg -i ${DEB} +dinstall: ${GEN_DEB} ${DOC_DEB} + dpkg -i ${GEN_DEB} ${DOC_DEB} + .PHONY: deb -${DEB} deb: +deb: + rm -f ${GEN_DEB} ${DOC_DEB}; + make ${GEN_DEB}; + make ${DOC_DEB}; + +DOC_DEB_FILES= \ + $(addsuffix .1.html, ${COMMAND_LIST}) \ + $(addsuffix .8.html, ${SERVICE_LIST}) \ + $(addsuffix .5.html, ${CONFIG_LIST}) \ + pve-admin-guide.pdf \ + pve-admin-guide.html \ + pve-admin-guide.epub \ + index.html + +${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES} + $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub + $(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 + rm -rf build + mkdir build + rsync -a doc-debian/ build/debian + mkdir -p build/usr/share/${DOC_PACKAGE} + mkdir -p build/usr/share/doc/${DOC_PACKAGE} + echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${DOC_PACKAGE}/SOURCE + # install doc files + install -m 0644 ${DOC_DEB_FILES} build/usr/share/${DOC_PACKAGE} + # install api doc viewer + mkdir build/usr/share/${DOC_PACKAGE}/api-viewer + install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer + cd build; dpkg-buildpackage -rfakeroot -b -us -uc + lintian ${DOC_DEB} + +${GEN_DEB}: ${GEN_DEB_SOURCES} 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} + mkdir -p build/usr/share/${GEN_PACKAGE} + mkdir -p build/usr/share/doc/${GEN_PACKAGE} + echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${GEN_PACKAGE}/SOURCE + install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE} + install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE} cd build; dpkg-buildpackage -rfakeroot -b -us -uc - lintian ${DEB} + lintian ${GEN_DEB} .PHONY: upload -upload: ${DEB} +upload: ${GEN_DEB} ${DOC_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/${GEN_PACKAGE}_*.deb + rm -f /pve/${DOCRELEASE}/extra/${DOC_PACKAGE}_*.deb rm -f /pve/${DOCRELEASE}/extra/Packages* - cp ${DEB} /pve/${DOCRELEASE}/extra + cp ${GEN_DEB} ${DOC_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 @@ -178,5 +237,5 @@ update: clean make all clean: - rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build + rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidata.js api-viewer/apidoc.js