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