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