X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=86c8bc9e2cddfd2d4233fe31bb555e82d0607d63;hp=008aed38a7ed2d245a1cd8a09902cea0ea0cb050;hb=d01fa25d6b5cf65d69900ebfd5a7920ed5de5082;hpb=caf01dfcdef6b14c4367f253e9bb683364d77827

diff --git a/Makefile b/Makefile
index 008aed3..86c8bc9 100644
--- a/Makefile
+++ b/Makefile
@@ -1,83 +1,270 @@
+DGDIR=.
 
+include ./pve-doc-generator.mk
 
-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		\
-	GFDL.adoc			\
+GEN_PACKAGE=pve-doc-generator
+DOC_PACKAGE=pve-docs
+
+# also update debian/changelog
+GEN_PKGREL=1
+# also update doc-debian/changelog
+DOC_PKGREL=2
+
+GITVERSION:=$(shell cat .git/refs/heads/master)
+
+GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${GEN_PKGREL}_amd64.deb
+DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${DOC_PKGREL}_all.deb
+
+CHAPTER_LIST=		\
+	sysadmin	\
+	pvecm		\
+	pmxcfs		\
+	pvesm		\
+	qm		\
+	pve-firewall	\
+	pveum		\
+	pct		\
+	ha-manager	\
+	vzdump		\
+	pve-faq		\
+	pve-bibliography
+
+
+COMMAND_LIST=		\
+	pvesubscription	\
+	pvecm 		\
+	qm 		\
+	qmrestore 	\
+	pveceph		\
+	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
+
+GEN_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-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
+
+SYSADMIN_SOURCES=				\
+	getting-help.adoc			\
+	pve-package-repos.adoc			\
+	pve-installation.adoc			\
+	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}			\
+	${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}		\
+	${VZDUMP_MAN1_SOURCES}			\
+	${PVEAM_MAN1_SOURCES}			\
+	${PVESUBSCRIPTION_MAN1_SOURCES}		\
+	${PVECEPH_MAN1_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}"
+
+BROWSER?=xdg-open
+
+all: index.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" -f manpage $*.adoc
-	test -z "$${NOVIEW}" && man -l $@ 
+chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
+	asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc
+	test -n "$${NOVIEW}" || $(BROWSER) $@ &
 
-%.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) $@ &
 
+%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
+	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
+	test -n "$${NOVIEW}" || $(BROWSER) $@ &
 
-all: pve-admin-guide.html
+.PHONY: index
+index: index.html
+	test -n "$${NOVIEW}" || $(BROWSER) index.html &
 
-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 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})
+	$(MAKE) NOVIEW=1 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
+	asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
 
 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.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
+	rm -rf pve-admin-guide.chunked
+	a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
+	test -n "$${NOVIEW}" || $(BROWSER) $@/index.html &
 
 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
-	a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" pve-admin-guide.adoc
-	test -z "$${NOVIEW}" && iceweasel $@ &
+	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) $@ &
+
+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: ${GEN_DEB} ${DOC_DEB}
+	dpkg -i ${GEN_DEB} ${DOC_DEB}
+
+
+.PHONY: deb
+deb:
+	rm -f ${GEN_DEB} ${DOC_DEB};
+	make ${GEN_DEB};
+	make ${DOC_DEB};
+
+DOC_DEB_FILES=								\
+	$(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST})) 	\
+	$(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.html
+	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/${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 ${GEN_DEB}
+
+.PHONY: upload
+upload: ${GEN_DEB} ${DOC_DEB}
+	umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw
+	mkdir -p /pve/${DOCRELEASE}/extra
+	rm -f /pve/${DOCRELEASE}/extra/${GEN_PACKAGE}_*.deb
+	rm -f /pve/${DOCRELEASE}/extra/${DOC_PACKAGE}_*.deb
+	rm -f /pve/${DOCRELEASE}/extra/Packages*
+	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
 
+.PHONY: update
+update: clean
+	rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc
+	rm -f api-viewer/apidata.js
+	rm -f pve-firewall-macros.adoc
+	make all
 
 clean:
-	rm -rf *~ *.html *.pdf *.epub *.1 *.8
+	rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html pve-admin-guide.chunked
+	find . -name '*~' -exec rm {} ';'