Makefile

   1 include /usr/share/dpkg/pkg-info.mk
   2
   3 DGDIR=.
   4 ASCIIDOC_PMG=./asciidoc-pmg
   5
   6 BUILDDIR ?= $(DEB_SOURCE)-$(DEB_VERSION)
   7 DSC=$(DEB_SOURCE)_$(DEB_VERSION).dsc
   8
   9 GEN_PACKAGE=pmg-doc-generator
  10 DOC_PACKAGE=pmg-docs
  11
  12 GEN_DEB=$(GEN_PACKAGE)_$(DEB_VERSION_UPSTREAM_REVISION)_all.deb
  13 DOC_DEB=$(DOC_PACKAGE)_$(DEB_VERSION_UPSTREAM_REVISION)_all.deb
  14
  15 export SOURCE_DATE_EPOCH ?= $(shell dpkg-parsechangelog -STimestamp)
  16 SOURCE_DATE_HUMAN := $(shell date -d "@$(SOURCE_DATE_EPOCH)")
  17
  18
  19 all: index.html
  20
  21 .PHONY: verify-images
  22 verify-images: png-verify.pl
  23         for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done
  24
  25 ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc))
  26 .pmg-doc-depends link-refs.json: $(ADOC_SOURCES_GUESS) scan-adoc-refs
  27         ./scan-adoc-refs *.adoc --depends .pmg-doc-depends.tmp > link-refs.json.tmp
  28         @cmp --quiet .pmg-doc-depends .pmg-doc-depends.tmp || mv .pmg-doc-depends.tmp .pmg-doc-depends
  29         @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
  30
  31 pmg-doc-generator.mk: .pmg-doc-depends pmg-doc-generator.mk.in
  32         cat pmg-doc-generator.mk.in .pmg-doc-depends > $@.tmp
  33         sed -i "s/@RELEASE@$$/$(DEB_VERSION_UPSTREAM)/" $@.tmp
  34         mv $@.tmp $@
  35
  36 -include ./pmg-doc-generator.mk
  37
  38 GEN_DEB_SOURCES=                                \
  39         pmg-doc-generator.mk                    \
  40         $(MANUAL_SOURCES)                       \
  41         docinfo.xml
  42
  43 GEN_SCRIPTS=                                    \
  44         gen-cluster.conf.5-opts.pl              \
  45         gen-fetchmail.conf.5-opts.pl            \
  46         gen-ldap.conf.5-opts.pl                 \
  47         gen-pmg.conf.5-opts.pl                  \
  48         gen-user.conf.5-opts.pl
  49
  50 API_VIEWER_FILES=                                                       \
  51         api-viewer/apidata.js                                           \
  52         api-viewer/PMGAPI.js                                            \
  53         /usr/share/javascript/proxmox-widget-toolkit-dev/APIViewer.js
  54
  55 API_VIEWER_SOURCES=                             \
  56         api-viewer/index.html                   \
  57         api-viewer/apidoc.js
  58
  59 asciidoc-pmg: asciidoc-pmg.in link-refs.json
  60         cat asciidoc-pmg.in link-refs.json >asciidoc-pmg.tmp
  61         sed -e s/@RELEASE@/$(DOCRELEASE)/ -i asciidoc-pmg.tmp
  62         chmod +x asciidoc-pmg.tmp
  63         mv asciidoc-pmg.tmp asciidoc-pmg
  64
  65 INDEX_INCLUDES=                                                         \
  66         pmg-admin-guide.pdf                                             \
  67         pmg-admin-guide.epub                                            \
  68         chapter-index-table.adoc                                        \
  69         man1-index-table.adoc                                           \
  70         man5-index-table.adoc                                           \
  71         man8-index-table.adoc                                           \
  72         $(sort $(addsuffix .html, $(MANUAL_PAGES)) $(CHAPTER_LIST))
  73
  74 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)"
  75
  76 BROWSER?=xdg-open
  77
  78
  79 README.html: README.adoc
  80         asciidoc -a toc $(ADOC_STDARG) -o $@ $<
  81
  82 .PHONY: index
  83 index: index.html
  84         $(BROWSER) index.html &
  85
  86 chapter-index-table.adoc: asciidoc-pmg
  87         ./asciidoc-pmg chapter-table >$@.tmp
  88         mv $@.tmp $@
  89
  90 man1-index-table.adoc: asciidoc-pmg
  91         ./asciidoc-pmg man1page-table >$@.tmp
  92         mv $@.tmp $@
  93
  94 man5-index-table.adoc: asciidoc-pmg
  95         ./asciidoc-pmg man5page-table >$@.tmp
  96         mv $@.tmp $@
  97
  98 man8-index-table.adoc: asciidoc-pmg
  99         ./asciidoc-pmg man8page-table >$@.tmp
 100         mv $@.tmp $@
 101
 102 index.html: index.adoc $(API_VIEWER_SOURCES) $(INDEX_INCLUDES)
 103         asciidoc $(ADOC_STDARG) -o $@ index.adoc
 104
 105 pmg-admin-guide.html: $(PMG_ADMIN_GUIDE_ADOCDEPENDS)
 106         asciidoc -a pmglogo $(ADOC_STDARG) -o $@ pmg-admin-guide.adoc
 107
 108 pmg-admin-guide.chunked: $(PMG_ADMIN_GUIDE_ADOCDEPENDS)
 109         rm -rf $@.tmp $@
 110         mkdir $@.tmp
 111         a2x -D $@.tmp -a docinfo -a docinfo1 -a icons -f chunked pmg-admin-guide.adoc
 112         mv $@.tmp/$@ $@
 113
 114 PMG_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pmg-docbook -f asciidoc/asciidoc-pmg.conf
 115 PMG_DBLATEX_OPTS='-p ./asciidoc/pmg-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
 116
 117 YEAR:=$(shell date "+%Y")
 118
 119 pmg-admin-guide-docinfo.xml: pmg-admin-guide-docinfo.xml.in
 120         sed -e 's/@RELEASE@/$(DOCRELEASE)/' -e 's/@YEAR@/$(YEAR)/' <$< >$@
 121
 122 pmg-copyright.adoc: pmg-copyright.adoc.in
 123         sed -e 's/@YEAR@/$(YEAR)/' <$< >$@
 124
 125 pmg-admin-guide.pdf: $(PMG_ADMIN_GUIDE_ADOCDEPENDS) docinfo.xml pmg-admin-guide-docinfo.xml
 126         rsvg-convert -f pdf -o proxmox-logo.pdf images/proxmox-logo.svg
 127         rsvg-convert -f pdf -o proxmox-ci-header.pdf images/proxmox-ci-header.svg
 128         grep ">Release $(DOCRELEASE)<" pmg-admin-guide-docinfo.xml || (echo "wrong release in  pmg-admin-guide-docinfo.xml" && false);
 129         a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="$(PMG_DOCBOOK_CONF)" --dblatex-opts $(PMG_DBLATEX_OPTS) pmg-admin-guide.adoc
 130         rm proxmox-logo.pdf proxmox-ci-header.pdf
 131
 132 pmg-admin-guide.epub: $(PMG_ADMIN_GUIDE_ADOCDEPENDS)
 133         rm -rf $@.tmp $@
 134         mkdir $@.tmp
 135         a2x -D $@.tmp -f epub --asciidoc-opts="$(PMG_DOCBOOK_CONF)" pmg-admin-guide.adoc
 136         mv $@.tmp/$@ $@
 137
 138 api-viewer/apidata.js: extractapi.pl
 139         ./extractapi.pl >$@
 140
 141 api-viewer/apidoc.js: $(API_VIEWER_FILES)
 142         cat $(API_VIEWER_FILES) >$@.tmp
 143         mv $@.tmp $@
 144
 145 $(BUILDDIR):
 146         rm -rf $@ $@.tmp
 147         rsync -a * $@.tmp
 148         echo "git clone git://git.proxmox.com/git/pmg-docs.git\\ngit checkout $(shell git rev-parse HEAD)" > $@.tmp/debian/SOURCE
 149         mv $@.tmp $@
 150
 151 .PHONY: dinstall
 152 dinstall: $(GEN_DEB) $(DOC_DEB)
 153         dpkg -i $(GEN_DEB) $(DOC_DEB)
 154
 155 .PHONY: dsc deb
 156 dsc: $(DSC)
 157 $(DSC): $(BUILDDIR)
 158         cd $(BUILDDIR); dpkg-buildpackage -S -us -uc -d
 159         lintian $(DSC)
 160
 161 sbuild: $(DSC)
 162         sbuild $(DSC)
 163
 164 deb: $(DOC_DEB)
 165         rm -f $(GEN_DEB) $(DOC_DEB)
 166         rm -rf $(BUILDDIR)
 167         $(MAKE) $(DOC_DEB)
 168
 169 $(GEN_DEB): $(DOC_DEB)
 170
 171 $(DOC_DEB): $(BUILDDIR)
 172         cd $(BUILDDIR); dpkg-buildpackage -b -us -uc
 173         lintian $(DOC_DEB) $(GEN_DEB)
 174
 175 .PHONY: clean-build
 176 clean-build:
 177         rm -rf $(BUILDDIR)
 178
 179 .PHONY: install
 180 install: gen-install doc-install
 181
 182 .PHONY: gen-install
 183 gen-install: $(GEN_DEB_SOURCES) asciidoc-pmg
 184         install -dm755 $(DESTDIR)/usr/bin
 185         install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)
 186         # install files
 187         install -m 0644 $(GEN_DEB_SOURCES) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
 188         install -m 0755 $(GEN_SCRIPTS) $(DESTDIR)/usr/share/$(GEN_PACKAGE)
 189         # install asciidoc-pmg
 190         install -m 0755 asciidoc-pmg $(DESTDIR)/usr/bin/
 191         install -dm755 $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
 192         install -m 0644 asciidoc/asciidoc-pmg.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
 193         install -m 0644 asciidoc/pmg-html.conf $(DESTDIR)/usr/share/$(GEN_PACKAGE)/asciidoc/
 194
 195 .PHONY: doc-install
 196 doc-install: index.html $(API_VIEWER_SOURCES) verify-images
 197         # install files for pmgdocs package
 198         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)
 199         install -dm755 $(DESTDIR)/usr/share/doc/$(DOC_PACKAGE)
 200         install -m 0644 index.html $(INDEX_INCLUDES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)
 201         # install screenshot images
 202         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/screenshot
 203         install -m 0644 images/screenshot/*.png $(DESTDIR)/usr/share/$(DOC_PACKAGE)/images/screenshot
 204         # install api doc viewer
 205         install -dm755 $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
 206         install -m 0644 $(API_VIEWER_SOURCES) $(DESTDIR)/usr/share/$(DOC_PACKAGE)/api-viewer
 207
 208 .PHONY: upload
 209 upload: UPLOAD_DIST ?= $(DEB_DISTRIBUTION)
 210 upload: $(GEN_DEB) $(DOC_DEB)
 211         tar cf - $(GEN_DEB) $(DOC_DEB) | ssh -X repoman@repo.proxmox.com -- upload --product pmg --dist $(UPLOAD_DIST)
 212
 213 .PHONY: update
 214 update: clean
 215         find . -regex '.*-\(opts\|synopsis\)\.adoc' -exec rm -f \{\} \;
 216         rm -f api-viewer/apidata.js
 217         make all
 218
 219 clean:
 220         find . -name '*~' -exec rm {} ';'
 221         rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8
 222         rm -f *.deb *dsc *.tar.* *.changes *.buildinfo *.build
 223         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
 224         rm -rf .pmg-doc-depends
 225         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
 226         rm -rf $(DEB_SOURCE)-[0-9]*