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