X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=Makefile;h=db7c9492d6656cfc7fc6d92929d53852d6774d22;hb=66e541d00400769a6b5aa237669968411e8a6d1b;hp=7764fcf2fcff07c568068d8db27a7c30e7804627;hpb=1421fd686b290e82e125415f37694258ba24046d;p=pve-docs.git diff --git a/Makefile b/Makefile index 7764fcf..db7c949 100644 --- a/Makefile +++ b/Makefile @@ -1,19 +1,25 @@ DGDIR=. +ASCIIDOC_PVE=./asciidoc-pve include ./pve-doc-generator.mk GEN_PACKAGE=pve-doc-generator DOC_PACKAGE=pve-docs +MEDIAWIKI_PACKAGE=pve-docs-mediawiki # also update debian/changelog -PKGREL=6 +PKGREL=7 GITVERSION:=$(shell cat .git/refs/heads/master) -GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb +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 CHAPTER_LIST= \ + pve-installation \ sysadmin \ pvecm \ pmxcfs \ @@ -49,7 +55,8 @@ COMMAND_LIST= \ pvesm \ pveum \ vzdump \ - ha-manager + ha-manager \ + pveperf SERVICE_LIST= \ pve-firewall \ @@ -74,6 +81,7 @@ GEN_DEB_SOURCES= \ pve-storage-iscsi.adoc \ pve-storage-iscsidirect.adoc \ pve-storage-lvm.adoc \ + pve-storage-lvmthin.adoc \ pve-storage-nfs.adoc \ pve-storage-rbd.adoc \ pve-storage-zfspool.adoc \ @@ -94,11 +102,22 @@ GEN_SCRIPTS= \ gen-pve-firewall-rules-opts.pl \ gen-pve-firewall-vm-opts.pl +INSTALLATION_SOURCES= \ + pve-usbstick.adoc \ + pve-system-requirements.adoc \ + pve-installation.adoc + +SYSADMIN_PARTS= \ + pve-network \ + pve-package-repos \ + system-software-updates \ + pve-disk-health-monitoring \ + local-lvm \ + local-zfs \ + system-timesync + SYSADMIN_SOURCES= \ - getting-help.adoc \ - pve-package-repos.adoc \ - pve-installation.adoc \ - system-software-updates.adoc \ + $(addsuffix .adoc, ${SYSADMIN_PARTS}) \ sysadmin.adoc API_VIEWER_SOURCES= \ @@ -112,6 +131,8 @@ PVE_ADMIN_GUIDE_SOURCES= \ ${SYSADMIN_SOURCES} \ pve-admin-guide.adoc \ pve-intro.adoc \ + getting-help.adoc \ + ${INSTALLATION_SOURCES} \ pmxcfs.adoc \ pmxcfs.8-cli.adoc \ pve-faq.adoc \ @@ -133,6 +154,7 @@ PVE_ADMIN_GUIDE_SOURCES= \ ${PVEAM_MAN1_SOURCES} \ ${PVESUBSCRIPTION_MAN1_SOURCES} \ ${PVECEPH_MAN1_SOURCES} \ + ${PVEPERF_MAN1_SOURCES} \ pve-bibliography.adoc \ $(addsuffix .adoc, ${COMMAND_LIST}) \ $(addsuffix .adoc, ${SERVICE_LIST}) \ @@ -140,9 +162,27 @@ PVE_ADMIN_GUIDE_SOURCES= \ GFDL.adoc \ attributes.txt -WIKI_IMPORTS= \ - $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST}))\ - $(addsuffix .5-plain.html, ${CONFIG_LIST}) \ +link-refs.json: scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES} + ./scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES} >link-refs.json + +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 + +WIKI_IMPORTS= \ + pve-usbstick-plain.html \ + getting-help-plain.html \ + pve-system-requirements-plain.html \ + $(addsuffix -plain.html, ${SYSADMIN_PARTS}) \ + $(addsuffix -plain.html, ${CHAPTER_LIST}) \ + $(addsuffix .5-plain.html, ${CONFIG_LIST}) \ $(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES})) INDEX_INCLUDES= \ @@ -166,29 +206,31 @@ all: index.html %-nwdiag.svg: %.nwdiag nwdiag -T svg $*.nwdiag -o $@; -chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc +%-plain.html: asciidoc-pve %.adoc + ./asciidoc-pve compile-wiki -o $@ $*.adoc + +chapter-sysadmin.html sysadmin-plain.html: ${SYSADMIN_SOURCES} -chapter-%-plain.html: %.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc -s -a wiki ${ADOC_STDARG} -o $@ $*.adoc +chapter-%.html: %.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES} + ./asciidoc-pve compile-chapter -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 asciidoc-pve ${PVE_COMMON_DOC_SOURCES} + ./asciidoc-pve compile-man-html -o $@ $*.adoc -%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc +pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES} + ./asciidoc-pve compile-man-html -o $@ pmxcfs.adoc -pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc +%.8.html: %.adoc %.8-synopsis.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES} + ./asciidoc-pve compile-man-html -o $@ $*.adoc -%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc +%.5.html: %.adoc %.5-opts.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES} + ./asciidoc-pve compile-man-html -o $@ $*.adoc -%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc +%.5-plain.html: %.adoc %.5-opts.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES} + ./asciidoc-pve compile-man-wiki -o $@ $*.adoc -%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES} - asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc +README.html: README.adoc + asciidoc ${ADOC_STDARG} -o $@ $< .PHONY: index index: index.html @@ -198,15 +240,18 @@ 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 + asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc 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 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} 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 + 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} a2x -f epub pve-admin-guide.adoc @@ -218,25 +263,27 @@ 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} +dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} + dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} .PHONY: deb deb: - rm -f ${GEN_DEB} ${DOC_DEB}; - make ${GEN_DEB}; - make ${DOC_DEB}; + rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; + make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; -${GEN_DEB} ${DOC_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} +${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 + 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} @@ -245,21 +292,15 @@ ${GEN_DEB} ${DOC_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER # 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 + # build Debian packages cd build; dpkg-buildpackage -rfakeroot -b -us -uc lintian ${GEN_DEB} lintian ${DOC_DEB} + lintian ${MEDIAWIKI_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 +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 @@ -269,5 +310,5 @@ update: clean make all clean: - rm -rf *.tmp.xml *.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 + 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 find . -name '*~' -exec rm {} ';'