X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=0212bbae8dcf6210bbd4315cd4ec2d4ac051dc9d;hp=48c364df8c1464f1250dadcfec50cfb6ba7c25a2;hb=1d4b22ab361240b63afaae842629afaa462b7abe;hpb=7aacca6f1d325ac2014e98852a40d3e967ccb216 diff --git a/Makefile b/Makefile index 48c364d..0212bba 100644 --- a/Makefile +++ b/Makefile @@ -6,9 +6,9 @@ GEN_PACKAGE=pve-doc-generator DOC_PACKAGE=pve-docs # also update debian/changelog -GEN_PKGREL=1 +GEN_PKGREL=2 # also update doc-debian/changelog -DOC_PKGREL=2 +DOC_PKGREL=3 GITVERSION:=$(shell cat .git/refs/heads/master) @@ -29,6 +29,16 @@ CHAPTER_LIST= \ pve-faq \ pve-bibliography +STORAGE_TYPES= \ + dir \ + glusterfs \ + iscsi \ + iscsidirect \ + lvm \ + lvmthin \ + nfs \ + rbd \ + zfspool COMMAND_LIST= \ pvesubscription \ @@ -76,6 +86,8 @@ GEN_DEB_SOURCES= \ 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 \ @@ -123,8 +135,6 @@ PVE_ADMIN_GUIDE_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}) \ @@ -132,10 +142,24 @@ PVE_ADMIN_GUIDE_SOURCES= \ 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}" +WIKI_IMPORTS= \ + $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST}))\ + $(addsuffix .5-plain.html, ${CONFIG_LIST}) \ + $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES})) + +INDEX_INCLUDES= \ + pve-admin-guide.pdf \ + pve-admin-guide.html \ + pve-admin-guide.epub \ + $(addsuffix .1.html, ${COMMAND_LIST}) \ + $(addsuffix .8.html, ${SERVICE_LIST}) \ + $(addsuffix .5.html, ${CONFIG_LIST}) \ + $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST})) + +ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" +ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} +ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} +ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} BROWSER?=xdg-open @@ -145,53 +169,49 @@ all: index.html nwdiag -T svg $*.nwdiag -o $@; chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc ${ADOC_STDARG} -o $@ $*.adoc - test -n "$${NOVIEW}" || $(BROWSER) $@ & + asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc + +chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES} + asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc + +pve-storage-%-plain.html: pve-storage-%.adoc ${PVE_COMMON_DOC_SOURCES} + asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ pve-storage-$*.adoc %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc - test -n "$${NOVIEW}" || $(BROWSER) $@ & - 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.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc - 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) $@ & + +%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} + asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc .PHONY: index index: index.html - test -n "$${NOVIEW}" || $(BROWSER) index.html & + $(BROWSER) index.html & -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}) - $(MAKE) NOVIEW=1 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST})) +index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc 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.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 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 -n "$${NOVIEW}" || $(BROWSER) $@ & api-viewer/apidata.js: extractapi.pl ./extractapi.pl >$@ @@ -203,24 +223,13 @@ api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js 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 +${DOC_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} rm -rf build mkdir build rsync -a doc-debian/ build/debian @@ -228,7 +237,8 @@ ${DOC_DEB}: index.html 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 -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 @@ -262,9 +272,9 @@ upload: ${GEN_DEB} ${DOC_DEB} 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 + 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 api-viewer/apidoc.js chapter-*.html pve-admin-guide.chunked + rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html chapter-*-plain.html chapter-*.html pve-admin-guide.chunked find . -name '*~' -exec rm {} ';'