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