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