X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=206a29e432223155cdc9dc40ff8957a1af55d1b9;hp=1567ce63e5c7e9de1b7664363a4ea8c031ddd7e3;hb=ceb4ea5b6133e92d4fda86447f54b2d3961f2eb7;hpb=1496dbe5b03dcb1cf4454d4be3e43d5ded6caef7 diff --git a/Makefile b/Makefile index 1567ce6..206a29e 100644 --- a/Makefile +++ b/Makefile @@ -6,14 +6,12 @@ GEN_PACKAGE=pve-doc-generator DOC_PACKAGE=pve-docs # also update debian/changelog -GEN_PKGREL=1 -# also update doc-debian/changelog -DOC_PKGREL=2 +PKGREL=5 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 +GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb +DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb CHAPTER_LIST= \ sysadmin \ @@ -29,6 +27,16 @@ CHAPTER_LIST= \ pve-faq \ pve-bibliography +STORAGE_TYPES= \ + dir \ + glusterfs \ + iscsi \ + iscsidirect \ + lvm \ + lvmthin \ + nfs \ + rbd \ + zfspool COMMAND_LIST= \ pvesubscription \ @@ -76,6 +84,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 \ @@ -130,6 +140,20 @@ PVE_ADMIN_GUIDE_SOURCES= \ GFDL.adoc \ attributes.txt +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} @@ -144,62 +168,48 @@ all: index.html chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES} asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc - test -n "$${NOVIEW}" || $(BROWSER) $@ & chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc -s ${ADOC_STDARG} -a toc -o chapter-$*-plain.html $*.adoc - test -n "$${NOVIEW}" || $(BROWSER) $@ & + 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 - test -n "$${NOVIEW}" || $(BROWSER) $@ & .PHONY: index index: index.html - test -n "$${NOVIEW}" || $(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})) - $(MAKE) NOVIEW=1 $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST})) - $(MAKE) NOVIEW=1 $(addsuffix .5-plain.html, ${CONFIG_LIST}) + $(BROWSER) index.html & + +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 >$@ @@ -211,51 +221,34 @@ 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 -plain.html, $(addprefix chapter-, ${CHAPTER_LIST})) \ - $(addsuffix .5-plain.html, ${CONFIG_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} +${GEN_DEB} ${DOC_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} rm -rf build mkdir build rsync -a debian/ build/debian + 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} - 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} + # 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 debain package cd build; dpkg-buildpackage -rfakeroot -b -us -uc lintian ${GEN_DEB} + lintian ${DOC_DEB} .PHONY: upload upload: ${GEN_DEB} ${DOC_DEB} @@ -272,7 +265,7 @@ 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: