X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=d1945919587c9c450544807c20595f9f17af63bc;hp=d2fec10f75af3924322094d6ff2aa15f7492db3c;hb=5bf279bd97434367dc9485e83abc56bb6541a93e;hpb=0840a66374ea6d49432f11addf1a32ddba3d6021

diff --git a/Makefile b/Makefile
index d2fec10..d194591 100644
--- a/Makefile
+++ b/Makefile
@@ -1,192 +1,159 @@
 DGDIR=.
+ASCIIDOC_PVE=./asciidoc-pve
 
-include ./pve-doc-generator.mk
-
-PACKAGE=pve-doc-generator
+GEN_PACKAGE=pve-doc-generator
+DOC_PACKAGE=pve-docs
+MEDIAWIKI_PACKAGE=pve-docs-mediawiki
 
 # also update debian/changelog
-PKGREL=1
+PKGREL=10
 
 GITVERSION:=$(shell cat .git/refs/heads/master)
 
-DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
-
-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
-
-DEB_SOURCES=					\
+ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
+
+GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
+DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
+MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
+
+all: index.html
+
+.pve-doc-depends link-refs.json: $(wildcard *.adoc) scan-adoc-refs
+	./scan-adoc-refs *.adoc --depends .pve-doc-depends > link-refs.json
+
+pve-doc-generator.mk: .pve-doc-depends pve-doc-generator.mk.in
+	cat pve-doc-generator.mk.in .pve-doc-depends > $@.tmp
+	mv $@.tmp $@
+
+include ./pve-doc-generator.mk
+
+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			\
+	${MANUAL_SOURCES}			\
+	pmxcfs.8-synopsis.adoc			\
 	docinfo.xml
 
 GEN_SCRIPTS=					\
 	gen-datacenter.cfg.5-opts.pl		\
 	gen-pct.conf.5-opts.pl			\
+	gen-pct-network-opts.pl			\
+	gen-pct-mountpoint-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
-
-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} -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}"
+API_VIEWER_SOURCES=				\
+	api-viewer/index.html			\
+	api-viewer/apidoc.js
 
-BROWSER?=xdg-open
+asciidoc-pve: asciidoc-pve.in link-refs.json
+	cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
+	sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
+	chmod +x asciidoc-pve.tmp
+	mv asciidoc-pve.tmp asciidoc-pve
 
-all: pve-admin-guide.html
+pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
+	cat pve-docs-mediawiki-import.in link-refs.json >  pve-docs-mediawiki-import.tmp
+	chmod +x pve-docs-mediawiki-import.tmp
+	mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
 
-%-nwdiag.svg: %.nwdiag
-	nwdiag -T svg $*.nwdiag -o $@;
+INDEX_INCLUDES=								\
+	pve-admin-guide.pdf 						\
+	pve-admin-guide.epub 						\
+	$(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
+
+ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
 
-%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
-	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+BROWSER?=xdg-open
 
 
-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) $@ &
+%-nwdiag.svg: %.nwdiag
+	nwdiag -T svg $*.nwdiag -o $@;
 
-%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
-	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+README.html: README.adoc
+	asciidoc ${ADOC_STDARG} -o $@ $<
 
-%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
-	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+.PHONY: index
+index: index.html
+	$(BROWSER) index.html &
 
-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 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
+index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} 
 	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=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
+	asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
 
-pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
+pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
+	rm -rf pve-admin-guide.chunked
+	a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
+
+pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
+	inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
+	inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
 	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) $@ &
+	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" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc-dblatex-custom.sty" pve-admin-guide.adoc
+	rm proxmox-logo.pdf proxmox-ci-header.pdf
 
-pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
+pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
 	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} ${MEDIAWIKI_DEB}
+	dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
 
 .PHONY: deb
-${DEB} deb:
+deb:
+	rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
+	make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
+
+${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import
 	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}
+	cp pve-docs-mediawiki-import build/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import
+	echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
+	# install files for pve-doc-generator package
+	mkdir -p build/usr/share/${GEN_PACKAGE}
+	mkdir -p build/usr/share/doc/${GEN_PACKAGE}
+	mkdir -p build/usr/bin
+	install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
+	install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
+	install -m 0755 asciidoc-pve build/usr/bin/
+	# install files for pvedocs package
+	mkdir -p build/usr/share/${DOC_PACKAGE}
+	mkdir -p build/usr/share/doc/${DOC_PACKAGE}
+	install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE}
+	install -m 0644 ${WIKI_IMPORTS} 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
+	# build Debian packages
 	cd build; dpkg-buildpackage -rfakeroot -b -us -uc
-	lintian ${DEB}
+	lintian ${GEN_DEB}
+	lintian ${DOC_DEB}
+	lintian ${MEDIAWIKI_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
+upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
+	tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
 
+.PHONY: update
 update: clean
-	rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
+	find . -regex '.*-\(opts\|synopsis\)\.adoc' -not -name pmxcfs.8-synopsis.adoc -exec rm -f \{\} \;
+	rm -f api-viewer/apidata.js
+	rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
 	make all
 
-clean:
-	rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build
-
+clean: 
+	rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import .pve-doc-depends pve-doc-generator.mk
+	find . -name '*~' -exec rm {} ';'