]> git.proxmox.com Git - pmg-docs.git/blobdiff - Makefile
api-viewer: properly HTML encode properties
[pmg-docs.git] / Makefile
index fb60defbd9157afb9ac7e982eff30ab6cfc9a958..8b125df1f87d7c0c8d4395064cd45da5aadf13e5 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,17 +1,25 @@
+include /usr/share/dpkg/pkg-info.mk
+
 DGDIR=.
 ASCIIDOC_PMG=./asciidoc-pmg
 
 GEN_PACKAGE=pmg-doc-generator
 DOC_PACKAGE=pmg-docs
+WEB_PACKAGE=pmg-docs-apache
 
 # also update debian/changelog
-PKGREL=5
+PKGREL=1
+
+GITVERSION:=$(shell git rev-parse HEAD)
 
 ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
 
-GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
-DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
-DOC_BUILDDEPS := dblatex, source-highlight, inkscape, imagemagick
+GEN_DEB=${GEN_PACKAGE}_${DEB_VERSION_UPSTREAM_REVISION}_${ARCH}.deb
+DOC_DEB=${DOC_PACKAGE}_${DEB_VERSION_UPSTREAM_REVISION}_all.deb
+WEB_DEB=${WEB_PACKAGE}_${DEB_VERSION_UPSTREAM_REVISION}_all.deb
+
+export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
+SOURCE_DATE_HUMAN := $(shell date -d "@${SOURCE_DATE_EPOCH}")
 
 
 all: index.html
@@ -28,9 +36,10 @@ ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wild
 
 pmg-doc-generator.mk: .pmg-doc-depends pmg-doc-generator.mk.in
        cat pmg-doc-generator.mk.in .pmg-doc-depends > $@.tmp
+       sed -i "s/@RELEASE@$$/${DEB_VERSION_UPSTREAM}/" $@.tmp
        mv $@.tmp $@
 
-include ./pmg-doc-generator.mk
+-include ./pmg-doc-generator.mk
 
 GEN_DEB_SOURCES=                               \
        pmg-doc-generator.mk                    \
@@ -39,7 +48,10 @@ GEN_DEB_SOURCES=                             \
 
 GEN_SCRIPTS=                                   \
        gen-cluster.conf.5-opts.pl              \
-       gen-pmg.conf.5-opts.pl
+       gen-fetchmail.conf.5-opts.pl            \
+       gen-ldap.conf.5-opts.pl                 \
+       gen-pmg.conf.5-opts.pl                  \
+       gen-user.conf.5-opts.pl
 
 API_VIEWER_SOURCES=                            \
        api-viewer/index.html                   \
@@ -60,7 +72,7 @@ INDEX_INCLUDES=                                                               \
        man8-index-table.adoc                                           \
        $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST})
 
-ADOC_STDARG=-b $(shell pwd)/asciidoc/pmg-html -f asciidoc/asciidoc-pmg.conf -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
+ADOC_STDARG=-b $(shell pwd)/asciidoc/pmg-html -f asciidoc/asciidoc-pmg.conf -a icons -a data-uri -a "date=${SOURCE_DATE_HUMAN}" -a "revnumber=${DOCRELEASE}"
 
 BROWSER?=xdg-open
 
@@ -95,23 +107,34 @@ pmg-admin-guide.html: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
        asciidoc -a pmglogo ${ADOC_STDARG} -o $@ pmg-admin-guide.adoc
 
 pmg-admin-guide.chunked: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
-       rm -rf pmg-admin-guide.chunked
-       a2x -a docinfo -a docinfo1 -a icons -f chunked pmg-admin-guide.adoc
+       rm -rf $@.tmp $@
+       mkdir $@.tmp
+       a2x -D $@.tmp -a docinfo -a docinfo1 -a icons -f chunked pmg-admin-guide.adoc
+       mv $@.tmp/$@ $@
 
 PMG_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pmg-docbook -f asciidoc/asciidoc-pmg.conf
+PMG_DBLATEX_OPTS='-p ./asciidoc/pmg-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
+
+YEAR:=$(shell date "+%Y")
 
 pmg-admin-guide-docinfo.xml: pmg-admin-guide-docinfo.xml.in
-       sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@
+       sed -e 's/@RELEASE@/${DOCRELEASE}/' -e 's/@YEAR@/${YEAR}/' <$< >$@
+
+pmg-copyright.adoc: pmg-copyright.adoc.in
+       sed -e 's/@YEAR@/${YEAR}/' <$< >$@
 
 pmg-admin-guide.pdf: ${PMG_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pmg-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
+       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}<" pmg-admin-guide-docinfo.xml || (echo "wrong release in  pmg-admin-guide-docinfo.xml" && false);
-       a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PMG_DOCBOOK_CONF}" --dblatex-opts "-p ./asciidoc/pmg-dblatex.xsl -s asciidoc/dblatex-custom.sty" pmg-admin-guide.adoc
+       a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PMG_DOCBOOK_CONF}" --dblatex-opts ${PMG_DBLATEX_OPTS} pmg-admin-guide.adoc
        rm proxmox-logo.pdf proxmox-ci-header.pdf
 
 pmg-admin-guide.epub: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
-       a2x -f epub --asciidoc-opts="${PMG_DOCBOOK_CONF}" pmg-admin-guide.adoc
+       rm -rf $@.tmp $@
+       mkdir $@.tmp
+       a2x -D $@.tmp -f epub --asciidoc-opts="${PMG_DOCBOOK_CONF}" pmg-admin-guide.adoc
+       mv $@.tmp/$@ $@
 
 api-viewer/apidata.js: extractapi.pl
        ./extractapi.pl >$@
@@ -124,65 +147,54 @@ dinstall: ${GEN_DEB} ${DOC_DEB}
        dpkg -i ${GEN_DEB} ${DOC_DEB}
 
 .PHONY: deb
-deb:
-       rm -f ${GEN_DEB} ${DOC_DEB}
-       make all-debs
+deb: ${DOC_DEB}
 
-.PHONY: all-debs
-all-debs: ${GEN_DEB} ${DOC_DEB}
+${WEB_DEB} ${GEN_DEB}: ${DOC_DEB}
+
+${DOC_DEB}:
+       rm -f ${GEN_DEB} ${DOC_DEB}
+       rm -rf build
+       rsync -a * build/
+       echo "git clone git://git.proxmox.com/git/pmg-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
+       cd build; dpkg-buildpackage -b -us -uc
+       lintian $(DOC_DEB) $(GEN_DEB) $(WEB_DEB)
 
 .PHONY: clean-build
 clean-build:
        rm -rf build
 
-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
-       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-pmg
-       $(call prepare_build,$(GEN_PACKAGE))
-       install -dm755 build-$(GEN_PACKAGE)/usr/bin
+.PHONY: install
+install: gen-install doc-install
+
+.PHONY: gen-install
+gen-install: $(GEN_DEB_SOURCES) asciidoc-pmg
+       install -dm755 ${DESTDIR}/usr/bin
+       install -dm755 $(DESTDIR)/usr/share/${GEN_PACKAGE}
        # 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 -m 0644 ${GEN_DEB_SOURCES} $(DESTDIR)/usr/share/${GEN_PACKAGE}
+       install -m 0755 ${GEN_SCRIPTS} $(DESTDIR)/usr/share/${GEN_PACKAGE}
        # install asciidoc-pmg
-       install -m 0755 asciidoc-pmg build-$(GEN_PACKAGE)/usr/bin/
-       install -dm755 build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
-       install -m 0644 asciidoc/asciidoc-pmg.conf build-$(GEN_PACKAGE)/usr/share/${GEN_PACKAGE}/asciidoc/
-       install -m 0644 asciidoc/pmg-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 $(API_VIEWER_SOURCES) verify-images
-       $(call prepare_build,$(DOC_PACKAGE))
-       sed -i -e '/^Build-Depends/{s/$$/, $(DOC_BUILDDEPS)/}' build-$(DOC_PACKAGE)/debian/control
+       install -m 0755 asciidoc-pmg $(DESTDIR)/usr/bin/
+       install -dm755 $(DESTDIR)/usr/share/${GEN_PACKAGE}/asciidoc/
+       install -m 0644 asciidoc/asciidoc-pmg.conf $(DESTDIR)/usr/share/${GEN_PACKAGE}/asciidoc/
+       install -m 0644 asciidoc/pmg-html.conf $(DESTDIR)/usr/share/${GEN_PACKAGE}/asciidoc/
+
+.PHONY: doc-install
+doc-install: index.html $(API_VIEWER_SOURCES) verify-images
        # install files for pmgdocs 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 -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}
+       install -dm755 $(DESTDIR)/usr/share/doc/${DOC_PACKAGE}
+       install -m 0644 index.html ${INDEX_INCLUDES} $(DESTDIR)/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 -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}/images/screenshot
+       install -m 0644 images/screenshot/*.png $(DESTDIR)/usr/share/${DOC_PACKAGE}/images/screenshot
        # install api doc viewer
-       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}
+       install -dm755 $(DESTDIR)/usr/share/${DOC_PACKAGE}/api-viewer
+       install -m 0644 ${API_VIEWER_SOURCES} $(DESTDIR)/usr/share/${DOC_PACKAGE}/api-viewer
 
 .PHONY: upload
-upload: ${GEN_DEB} ${DOC_DEB}
-       tar cf - ${GEN_DEB} ${DOC_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pmg --dist stretch
+upload: ${WEB_DEB} ${GEN_DEB} ${DOC_DEB}
+       tar cf - ${WEB_DEB} ${GEN_DEB} ${DOC_DEB} | ssh -X repoman@repo.proxmox.com -- upload --product pmg --dist stretch
 
 .PHONY: update
 update: clean
@@ -196,5 +208,5 @@ clean:
        rm -f *.deb *.changes *.buildinfo
        rm -f api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pmg-admin-guide.chunked asciidoc-pmg link-refs.json .asciidoc-pmg-tmp_* pmg-smtp-filter.8-synopsis.adoc pmgpolicy.8-synopsis.adoc pmgsh.1-synopsis.adoc
        rm -rf .pmg-doc-depends 
-       rm -f pmg-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pmg-admin-guide-docinfo.xml
-       rm -rf build-*
+       rm -f pmg-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pmg-admin-guide-docinfo.xml pmg-copyright.adoc
+       rm -rf build*