X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=Makefile;h=93af3ea97032e45a6718394e09c290507a02a61d;hb=4ecb55a9a54cbcf6e537c684e553ff5435b89739;hp=f3981a6b093dfcd5f6efb859206874901503e921;hpb=828a27f53c70ecf1c7edc6d86213b9ebe234eaa2;p=pve-docs.git

diff --git a/Makefile b/Makefile
index f3981a6..f27f3ec 100644
--- a/Makefile
+++ b/Makefile
@@ -1,176 +1,235 @@
 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
-
-DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
-
-
-DEB_SOURCES=			\
-	pve-doc-generator.mk	\
-	attributes.txt		\
-	pvesm.adoc		\
-	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	\
-	pveum.adoc		\
-	vzdump.adoc		\
-	pve-firewall.adoc	\
-	qm.adoc			\
-	pct.adoc		\
-	pveam.adoc		\
-	ha-manager.adoc		\
-	pve-copyright.adoc	\
+PKGREL=9
+
+GITVERSION:=$(shell cat .git/refs/heads/master)
+
+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
+DOC_BUILDDEPS := asciidoc-dblatex, source-highlight, librsvg2-bin
+
+
+all: index.html
+
+.PHONY: verify-images
+verify-images:
+	for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
+
+ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
+.pve-doc-depends link-refs.json: ${ADOC_SOURCES_GUESS} scan-adoc-refs
+	./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp
+	@cmp --quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends
+	@cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp 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			\
+	${MANUAL_SOURCES}			\
+	pmxcfs.8-synopsis.adoc			\
 	docinfo.xml
 
 GEN_SCRIPTS=					\
-	gen-datacenter-cfg-opts-adoc.pl		\
-	gen-pct-conf-opts-adoc.pl		\
+	gen-ha-groups-opts.pl			\
+	gen-ha-resources-opts.pl		\
+	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		\
-	gen-vm-conf-opts-adoc.pl
-
-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.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}	\
-	${PVESM_MAN1_SOURCES}		\
-	${QM_SOURCES}			\
-	${PCT_SOURCES}			\
-	${PVEAM_SOURCES}		\
-	${PVEUM_SOURCES}		\
-	${VZDUMP_SOURCES}		\
-	${HA_SOURCES}			\
-	images/cluster-nwdiag.svg	\
-	images/node-nwdiag.svg		\
-	pve-bibliography.adoc		\
-	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}"
+	gen-pve-firewall-vm-opts.pl
+
+API_VIEWER_SOURCES=				\
+	api-viewer/index.html			\
+	api-viewer/apidoc.js
+
+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
+
+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
+
+INDEX_INCLUDES=								\
+	pve-admin-guide.pdf 						\
+	pve-admin-guide.epub 						\
+	chapter-index-table.adoc					\
+	man1-index-table.adoc						\
+	man5-index-table.adoc						\
+	man8-index-table.adoc						\
+	$(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
+
+ADOC_STDARG=-b $(shell pwd)/asciidoc/pve-html -f asciidoc/asciidoc-pve.conf -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
 
 BROWSER?=xdg-open
 
-all: pve-admin-guide.html
 
 %-nwdiag.svg: %.nwdiag
 	nwdiag -T svg $*.nwdiag -o $@;
 
-%.1: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
-	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
-	test -n "$${NOVIEW}" || man -l $@
+README.html: README.adoc
+	asciidoc -a toc ${ADOC_STDARG} -o $@ $<
+
+.PHONY: index
+index: index.html
+	$(BROWSER) index.html &
 
-%.1.html: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
-	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+chapter-index-table.adoc: asciidoc-pve
+	./asciidoc-pve chapter-table >$@.tmp
+	mv $@.tmp $@
 
+man1-index-table.adoc: asciidoc-pve
+	./asciidoc-pve man1page-table >$@.tmp
+	mv $@.tmp $@
 
-%.8-synopsis.adoc:
-	perl -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
+man5-index-table.adoc: asciidoc-pve
+	./asciidoc-pve man5page-table >$@.tmp
 	mv $@.tmp $@
 
-%.8: %.adoc %.8-synopsis.adoc docinfo.xml
-	a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
-	test -n "$${NOVIEW}" || man -l $@
+man8-index-table.adoc: asciidoc-pve
+	./asciidoc-pve man8page-table >$@.tmp
+	mv $@.tmp $@
 
-%.8.html: %.adoc %.8-synopsis.adoc docinfo.xml
-	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
+	asciidoc ${ADOC_STDARG} -o $@ index.adoc
 
-%.5: %.adoc %.5-opts.adoc docinfo.xml
-	a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
-	test -n "$${NOVIEW}" || man -l $@
+pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
+	asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
 
-%.5.html: %.adoc %.5-opts.adoc docinfo.xml
-	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+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
 
-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=${DOCRELEASE}" index.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) index.html &
+PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf
+PVE_DBLATEX_OPTS='-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
 
-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-docinfo.xml: pve-admin-guide-docinfo.xml.in
+	sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
 
-pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
+pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml
+	rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
+	rsvg-convert -f pdf -o 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 --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts ${PVE_DBLATEX_OPTS} pve-admin-guide.adoc
+	rm proxmox-logo.pdf proxmox-ci-header.pdf
 
-pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
-	a2x -f epub pve-admin-guide.adoc
-	test -n "$${NOVIEW}" || $(BROWSER) $@ &
+pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
+	a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc
+
+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 all-debs
+
+.PHONY: all-debs
+all-debs: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
+
+.PHONY: clean-build
+clean-build:
 	rm -rf build
-	mkdir build
-	rsync -a debian/ build/debian
-	mkdir -p build/usr/share/${PACKAGE}
-	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}
+
+define prepare_build
+	rm -rf build-$1
+	mkdir build-$1
+	cp -a debian build-$1/debian
+	mv build-$1/debian/control.in build-$1/debian/control
+	echo >> build-$1/debian/control
+	cat debian/$1.control >> build-$1/debian/control
+	echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build-$1/debian/SOURCE
+	install -dm755 build-$1/usr/share/$1
+	install -dm755 build-$1/usr/share/doc/$1
+endef
+
+.PHONY: gen-deb
+gen-deb: $(GEN_DEB)
+$(GEN_DEB): $(GEN_DEB_SOURCES) asciidoc-pve asciidoc/mediawiki.conf
+	$(call prepare_build,$(GEN_PACKAGE))
+	install -dm755 build-$(GEN_PACKAGE)/usr/bin
+	# install files
+	install -m 0644 ${GEN_DEB_SOURCES} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
+	install -m 0755 ${GEN_SCRIPTS} build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}
+	# install asciidoc-pve
+	install -m 0755 asciidoc-pve build-$(GEN_PACKAGE)/usr/bin/
+	install -D -m 0644 asciidoc/mediawiki.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf
+	install -m 0644 asciidoc/asciidoc-pve.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
+	install -m 0644 asciidoc/pve-html.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
+	cd build-$(GEN_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
+	lintian ${GEN_DEB}
+
+.PHONY: doc-deb
+doc-deb: $(DOC_DEB)
+$(DOC_DEB): index.html $(WIKI_IMPORTS) $(API_VIEWER_SOURCES) verify-images
+	$(call prepare_build,$(DOC_PACKAGE))
+	sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
+	# install files for pvedocs package
+	install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
+	install -dm755 build-$(DOC_PACKAGE)/usr/share/doc/${DOC_PACKAGE}
+	install -m 0644 index.html ${INDEX_INCLUDES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
+	install -m 0644 ${WIKI_IMPORTS} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}
+	# install screenshot images
+	install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
+	install -m 0644 images/screenshot/*.png build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/images/screenshot
+	# install api doc viewer
+	install -dm755 build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
+	install -m 0644 ${API_VIEWER_SOURCES} build-$(DOC_PACKAGE)/usr/share/${DOC_PACKAGE}/api-viewer
+	cd build-$(DOC_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
+	lintian ${DOC_DEB}
+
+.PHONY: mediawiki-deb
+mediawiki-deb: $(MEDIAWIKI_DEB)
+$(MEDIAWIKI_DEB): pve-docs-mediawiki-import
+	$(call prepare_build,$(MEDIAWIKI_PACKAGE))
+	cp pve-docs-mediawiki-import build-$(MEDIAWIKI_PACKAGE)/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import
+	cd build-$(MEDIAWIKI_PACKAGE) && dpkg-buildpackage -rfakeroot -b -us -uc
+	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 -X repoman@repo.proxmox.com -- upload --product pve --dist stretch
 
+.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
+	rm -f *.deb *.changes *.buildinfo
+	rm -f 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 
+	rm -rf .pve-doc-depends 
+	rm -f pve-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pve-admin-guide-docinfo.xml
+	rm -rf build-*