2 ASCIIDOC_PMG
=.
/asciidoc-pmg
4 GEN_PACKAGE
=pmg-doc-generator
7 # also update debian/changelog
10 GITVERSION
:=$(shell git rev-parse HEAD
)
12 ARCH
:=$(shell dpkg-architecture
-qDEB_BUILD_ARCH
)
14 GEN_DEB
=${GEN_PACKAGE}_
${DOCRELEASE}-${PKGREL}_
${ARCH}.deb
15 DOC_DEB
=${DOC_PACKAGE}_
${DOCRELEASE}-${PKGREL}_all.deb
18 export SOURCE_DATE_EPOCH ?
= $(shell dpkg-parsechangelog
-STimestamp
)
19 SOURCE_DATE_HUMAN
:= $(shell date
-d
"@${SOURCE_DATE_EPOCH}")
25 verify-images
: png-verify.pl
26 for i in .
/images
/screenshot
/*.png
; do .
/png-verify.pl
$$i; done
28 ADOC_SOURCES_GUESS
=$(filter-out %-synopsis.adoc
%-opts.adoc
%-table.adoc
, $(wildcard *.adoc
))
29 .pmg-doc-depends link-refs.json
: ${ADOC_SOURCES_GUESS} scan-adoc-refs
30 .
/scan-adoc-refs
*.adoc
--depends .pmg-doc-depends.tmp
> link-refs.json.tmp
31 @cmp
--quiet .pmg-doc-depends .pmg-doc-depends.tmp || mv .pmg-doc-depends.tmp .pmg-doc-depends
32 @cmp
--quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json
34 pmg-doc-generator.mk
: .pmg-doc-depends pmg-doc-generator.mk.in
35 cat pmg-doc-generator.mk.in .pmg-doc-depends
> $@.tmp
38 -include .
/pmg-doc-generator.mk
41 pmg-doc-generator.mk \
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
53 api-viewer
/index.html \
56 asciidoc-pmg
: asciidoc-pmg.in link-refs.json
57 cat asciidoc-pmg.in link-refs.json
>asciidoc-pmg.tmp
58 sed
-e s
/@RELEASE@
/${DOCRELEASE}/ -i asciidoc-pmg.tmp
59 chmod
+x asciidoc-pmg.tmp
60 mv asciidoc-pmg.tmp asciidoc-pmg
64 pmg-admin-guide.epub \
65 chapter-index-table.adoc \
66 man1-index-table.adoc \
67 man5-index-table.adoc \
68 man8-index-table.adoc \
69 $(sort $(addsuffix .html
, ${MANUAL_PAGES}) ${CHAPTER_LIST})
71 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}"
76 README.html
: README.adoc
77 asciidoc
-a toc
${ADOC_STDARG} -o
$@
$<
81 $(BROWSER
) index.html
&
83 chapter-index-table.adoc
: asciidoc-pmg
84 .
/asciidoc-pmg chapter-table
>$@.tmp
87 man1-index-table.adoc
: asciidoc-pmg
88 .
/asciidoc-pmg man1page-table
>$@.tmp
91 man5-index-table.adoc
: asciidoc-pmg
92 .
/asciidoc-pmg man5page-table
>$@.tmp
95 man8-index-table.adoc
: asciidoc-pmg
96 .
/asciidoc-pmg man8page-table
>$@.tmp
99 index.html
: index.adoc
${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
100 asciidoc
${ADOC_STDARG} -o
$@ index.adoc
102 pmg-admin-guide.html
: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
103 asciidoc
-a pmglogo
${ADOC_STDARG} -o
$@ pmg-admin-guide.adoc
105 pmg-admin-guide.chunked
: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
108 a2x
-D
$@.tmp
-a docinfo
-a docinfo1
-a icons
-f chunked pmg-admin-guide.adoc
111 PMG_DOCBOOK_CONF
=-b
$(shell pwd
)/asciidoc
/pmg-docbook
-f asciidoc
/asciidoc-pmg.conf
112 PMG_DBLATEX_OPTS
='-p ./asciidoc/pmg-dblatex.xsl -s asciidoc/dblatex-custom.sty -c asciidoc/dblatex-export.conf'
114 YEAR
:=$(shell date
"+%Y")
116 pmg-admin-guide-docinfo.xml
: pmg-admin-guide-docinfo.xml.in
117 sed
-e
's/@RELEASE@/${DOCRELEASE}/' -e
's/@YEAR@/${YEAR}/' <$< >$@
119 pmg-copyright.adoc
: pmg-copyright.adoc.in
120 sed
-e
's/@YEAR@/${YEAR}/' <$< >$@
122 pmg-admin-guide.pdf
: ${PMG_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pmg-admin-guide-docinfo.xml
123 rsvg-convert
-f pdf
-o proxmox-logo.pdf images
/proxmox-logo.svg
124 rsvg-convert
-f pdf
-o proxmox-ci-header.pdf images
/proxmox-ci-header.svg
125 grep
">Release ${DOCRELEASE}<" pmg-admin-guide-docinfo.xml ||
(echo
"wrong release in pmg-admin-guide-docinfo.xml" && false
);
126 a2x
-a docinfo
-a docinfo1
-f pdf
-L
--asciidoc-opts
="${PMG_DOCBOOK_CONF}" --dblatex-opts
${PMG_DBLATEX_OPTS} pmg-admin-guide.adoc
127 rm proxmox-logo.pdf proxmox-ci-header.pdf
129 pmg-admin-guide.epub
: ${PMG_ADMIN_GUIDE_ADOCDEPENDS}
132 a2x
-D
$@.tmp
-f epub
--asciidoc-opts
="${PMG_DOCBOOK_CONF}" pmg-admin-guide.adoc
135 api-viewer
/apidata.js
: extractapi.pl
138 api-viewer
/apidoc.js
: api-viewer
/apidata.js api-viewer
/PMGAPI.js
139 cat api-viewer
/apidata.js api-viewer
/PMGAPI.js
>$@
142 dinstall
: ${GEN_DEB} ${DOC_DEB}
143 dpkg
-i
${GEN_DEB} ${DOC_DEB}
148 ${GEN_DEB}: ${DOC_DEB}
151 rm -f
${GEN_DEB} ${DOC_DEB}
154 echo
"git clone git://git.proxmox.com/git/pmg-docs.git\\ngit checkout ${GITVERSION}" > build
/debian
/SOURCE
155 cd build
; dpkg-buildpackage
-b
-us
-uc
156 lintian
$(DOC_DEB
) $(GEN_DEB
)
163 install: gen-install doc-install
166 gen-install
: $(GEN_DEB_SOURCES
) asciidoc-pmg
167 install -dm755
${DESTDIR}/usr
/bin
168 install -dm755
$(DESTDIR
)/usr
/share
/${GEN_PACKAGE}
170 install -m
0644 ${GEN_DEB_SOURCES} $(DESTDIR
)/usr
/share
/${GEN_PACKAGE}
171 install -m
0755 ${GEN_SCRIPTS} $(DESTDIR
)/usr
/share
/${GEN_PACKAGE}
172 # install asciidoc-pmg
173 install -m
0755 asciidoc-pmg
$(DESTDIR
)/usr
/bin
/
174 install -dm755
$(DESTDIR
)/usr
/share
/${GEN_PACKAGE}/asciidoc
/
175 install -m
0644 asciidoc
/asciidoc-pmg.conf
$(DESTDIR
)/usr
/share
/${GEN_PACKAGE}/asciidoc
/
176 install -m
0644 asciidoc
/pmg-html.conf
$(DESTDIR
)/usr
/share
/${GEN_PACKAGE}/asciidoc
/
179 doc-install
: index.html
$(API_VIEWER_SOURCES
) verify-images
180 # install files for pmgdocs package
181 install -dm755
$(DESTDIR
)/usr
/share
/${DOC_PACKAGE}
182 install -dm755
$(DESTDIR
)/usr
/share
/doc
/${DOC_PACKAGE}
183 install -m
0644 index.html
${INDEX_INCLUDES} $(DESTDIR
)/usr
/share
/${DOC_PACKAGE}
184 # install screenshot images
185 install -dm755
$(DESTDIR
)/usr
/share
/${DOC_PACKAGE}/images
/screenshot
186 install -m
0644 images
/screenshot
/*.png
$(DESTDIR
)/usr
/share
/${DOC_PACKAGE}/images
/screenshot
187 # install api doc viewer
188 install -dm755
$(DESTDIR
)/usr
/share
/${DOC_PACKAGE}/api-viewer
189 install -m
0644 ${API_VIEWER_SOURCES} $(DESTDIR
)/usr
/share
/${DOC_PACKAGE}/api-viewer
192 upload
: ${GEN_DEB} ${DOC_DEB}
193 tar cf
- ${GEN_DEB} ${DOC_DEB} | ssh
-X repoman@repo.proxmox.com
-- upload
--product pmg
--dist stretch
197 find .
-regex
'.*-\(opts\|synopsis\)\.adoc' -exec
rm -f \
{\
} \
;
198 rm -f api-viewer
/apidata.js
202 find .
-name
'*~' -exec
rm {} ';'
203 rm -rf
*.html
*.pdf
*.epub
*.tmp
*.1 *.5 *.8
204 rm -f
*.deb
*.changes
*.buildinfo
205 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
206 rm -rf .pmg-doc-depends
207 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