GEN_PACKAGE=pve-doc-generator
DOC_PACKAGE=pve-docs
+MEDIAWIKI_PACKAGE=pve-docs-mediawiki
# also update debian/changelog
-GEN_PKGREL=1
-# also update doc-debian/changelog
-DOC_PKGREL=2
+PKGREL=3
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
+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 \
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 \
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 \
+ local-lvm \
+ local-zfs
+
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= \
${SYSADMIN_SOURCES} \
pve-admin-guide.adoc \
pve-intro.adoc \
+ getting-help.adoc \
+ ${INSTALLATION_SOURCES} \
pmxcfs.adoc \
pmxcfs.8-cli.adoc \
pve-faq.adoc \
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
+ chmod +x asciidoc-pve.tmp
+ mv asciidoc-pve.tmp asciidoc-pve
+
+WIKI_IMPORTS= \
+ section-pve-usbstick-plain.html \
+ section-getting-help-plain.html \
+ section-pve-system-requirements-plain.html \
+ $(addsuffix -plain.html, $(addprefix sysadmin-, ${SYSADMIN_PARTS})) \
+ $(addsuffix -plain.html, $(addprefix chapter-, ${CHAPTER_LIST})) \
+ $(addsuffix .5-plain.html, ${CONFIG_LIST}) \
$(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES}))
INDEX_INCLUDES= \
%-nwdiag.svg: %.nwdiag
nwdiag -T svg $*.nwdiag -o $@;
+sysadmin-%-plain.html: %.adoc
+ asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
+
+section-%-plain.html: %.adoc
+ asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc
+
+chapter-sysadmin.html chapter-sysadmin-plain.html: ${SYSADMIN_SOURCES}
+
chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
asciidoc ${ADOC_STDARG} -a toc -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
$(BROWSER) index.html &
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
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};
-${DOC_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES}
+${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES}
rm -rf build
mkdir build
- rsync -a doc-debian/ build/debian
+ 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}
+ 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}
- 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 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
- cd build; dpkg-buildpackage -rfakeroot -b -us -uc
- lintian ${DOC_DEB}
-
-${GEN_DEB}: ${GEN_DEB_SOURCES}
- rm -rf build
- mkdir build
- rsync -a debian/ build/debian
- 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}
+ # 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
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 chapter-*-plain.html chapter-*.html pve-admin-guide.chunked
+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 asciidoc-pve link-refs.json
find . -name '*~' -exec rm {} ';'
projects / pve-docs.git / blobdiff