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=5
+PKGREL=4
GITVERSION:=$(shell cat .git/refs/heads/master)
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
-CHAPTER_LIST= \
- pve-installation \
- sysadmin \
- pvecm \
- pmxcfs \
- pvesm \
- qm \
- pve-firewall \
- pveum \
- pct \
- ha-manager \
- vzdump \
- pve-faq \
- pve-bibliography
-
-STORAGE_TYPES= \
- dir \
- glusterfs \
- iscsi \
- iscsidirect \
- lvm \
- lvmthin \
- nfs \
- rbd \
- zfspool
-
-COMMAND_LIST= \
- pvesubscription \
- pvecm \
- qm \
- qmrestore \
- pveceph \
- pct \
- pveam \
- pvesm \
- pveum \
- vzdump \
- ha-manager \
- pveperf
-
-SERVICE_LIST= \
- pve-firewall \
- pve-ha-crm \
- pve-ha-lrm \
- pvestatd \
- pmxcfs \
- pveproxy \
- spiceproxy \
- pvedaemon
-
-CONFIG_LIST=datacenter.cfg qm.conf pct.conf
+.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 \
- 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-lvmthin.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-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-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
-
-SYSADMIN_SOURCES= \
- $(addsuffix .adoc, ${SYSADMIN_PARTS}) \
- sysadmin.adoc
-
API_VIEWER_SOURCES= \
api-viewer/index.html \
api-viewer/apidoc.js
-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 \
- getting-help.adoc \
- ${INSTALLATION_SOURCES} \
- 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} \
- ${PVEPERF_MAN1_SOURCES} \
- pve-bibliography.adoc \
- $(addsuffix .adoc, ${COMMAND_LIST}) \
- $(addsuffix .adoc, ${SERVICE_LIST}) \
- $(addsuffix .adoc, ${CONFIG_LIST}) \
- GFDL.adoc \
- attributes.txt
-
-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 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= \
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}))
+ 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= -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}
+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: index.html
%-nwdiag.svg: %.nwdiag
nwdiag -T svg $*.nwdiag -o $@;
-%-plain.html: asciidoc-pve %.adoc
- ./asciidoc-pve compile-wiki -o $@ $*.adoc
-
-chapter-sysadmin.html sysadmin-plain.html: ${SYSADMIN_SOURCES}
-
-chapter-%.html: %.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES}
- ./asciidoc-pve compile-chapter -o $@ $*.adoc
-
-%.1.html: %.adoc %.1-synopsis.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES}
- ./asciidoc-pve compile-man-html -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
-
-%.8.html: %.adoc %.8-synopsis.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES}
- ./asciidoc-pve compile-man-html -o $@ $*.adoc
-
-%.5.html: %.adoc %.5-opts.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES}
- ./asciidoc-pve compile-man-html -o $@ $*.adoc
-
-%.5-plain.html: %.adoc %.5-opts.adoc asciidoc-pve ${PVE_COMMON_DOC_SOURCES}
- ./asciidoc-pve compile-man-wiki -o $@ $*.adoc
-
README.html: README.adoc
- asciidoc ${ADOC_STDARG} -o $@ $<
+ asciidoc -a toc ${ADOC_STDARG} -o $@ $<
.PHONY: index
index: index.html
$(BROWSER) index.html &
-index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
- asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
+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 $@
+
+man5-index-table.adoc: asciidoc-pve
+ ./asciidoc-pve man5page-table >$@.tmp
+ mv $@.tmp $@
+
+man8-index-table.adoc: asciidoc-pve
+ ./asciidoc-pve man8page-table >$@.tmp
+ mv $@.tmp $@
+
+index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
+ asciidoc ${ADOC_STDARG} -o $@ index.adoc
-pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
- asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
+pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS}
+ asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc
-pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
+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_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
+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-docinfo.xml: pve-admin-guide-docinfo.xml.in
+ sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
+
+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" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc-dblatex-custom.sty" pve-admin-guide.adoc
+ 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
+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 >$@
.PHONY: deb
deb:
- rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
- make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
+ rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
+ make all-debs
-${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import
+.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
- 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/
+
+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
- 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 -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
- 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 ${GEN_DEB}
+ 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: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
- tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload
+ 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 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 {} ';'
+ 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-*