[pve-docs.git] / Makefile

DGDIR=.

include ./pve-doc-generator.mk

GEN_PACKAGE=pve-doc-generator
DOC_PACKAGE=pve-docs
MEDIAWIKI_PACKAGE=pve-docs-mediawiki

# also update debian/changelog
PKGREL=5

GITVERSION:=$(shell cat .git/refs/heads/master)

ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)

GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb

CHAPTER_LIST=		\
	pve-installation 	\
	sysadmin	\
	pvecm		\
	pmxcfs		\
	pvesm		\
	qm		\
	pve-firewall	\
	pveum		\
	pct		\
	ha-manager	\
	vzdump		\
	pve-faq		\
	pve-bibliography

STORAGE_TYPES=		\
	dir		\
	glusterfs	\
	iscsi		\
	iscsidirect	\
	lvm		\
	lvmthin		\
	nfs		\
	rbd		\
	zfspool

COMMAND_LIST=		\
	pvesubscription	\
	pvecm 		\
	qm 		\
	qmrestore 	\
	pveceph		\
	pct 		\
	pveam 		\
	pvesm 		\
	pveum 		\
	vzdump 		\
	ha-manager	\
	pveperf

SERVICE_LIST=		\
	pve-firewall 	\
	pve-ha-crm 	\
	pve-ha-lrm 	\
	pvestatd 	\
	pmxcfs 		\
	pveproxy	\
	spiceproxy	\
	pvedaemon

CONFIG_LIST=datacenter.cfg qm.conf pct.conf

GEN_DEB_SOURCES=				\
	pve-doc-generator.mk			\
	attributes.txt				\
	$(addsuffix .adoc, ${COMMAND_LIST}) 	\
	$(addsuffix .adoc, ${SERVICE_LIST}) 	\
	$(addsuffix .adoc, ${CONFIG_LIST}) 	\
	pve-storage-dir.adoc 			\
	pve-storage-glusterfs.adoc		\
	pve-storage-iscsi.adoc			\
	pve-storage-iscsidirect.adoc		\
	pve-storage-lvm.adoc			\
	pve-storage-lvmthin.adoc		\
	pve-storage-nfs.adoc			\
	pve-storage-rbd.adoc			\
	pve-storage-zfspool.adoc		\
	pmxcfs.8-cli.adoc			\
	pve-copyright.adoc			\
	docinfo.xml

GEN_SCRIPTS=					\
	gen-datacenter.cfg.5-opts.pl		\
	gen-pct.conf.5-opts.pl			\
	gen-pct-network-opts.pl			\
	gen-pct-mountpoint-opts.pl		\
	gen-qm.conf.5-opts.pl			\
	gen-vzdump.conf.5-opts.pl		\
	gen-pve-firewall-cluster-opts.pl	\
	gen-pve-firewall-host-opts.pl		\
	gen-pve-firewall-macros-adoc.pl		\
	gen-pve-firewall-rules-opts.pl		\
	gen-pve-firewall-vm-opts.pl

INSTALLATION_SOURCES=				\
	pve-usbstick.adoc			\
	pve-system-requirements.adoc		\
	pve-installation.adoc

SYSADMIN_PARTS=					\
	pve-network				\
	pve-package-repos			\
	system-software-updates			\
	pve-disk-health-monitoring		\
	local-lvm				\
	local-zfs

SYSADMIN_SOURCES=				\
	$(addsuffix .adoc, ${SYSADMIN_PARTS})	\
	sysadmin.adoc

API_VIEWER_SOURCES=				\
	api-viewer/index.html			\
	api-viewer/apidoc.js

PVE_ADMIN_GUIDE_SOURCES=			\
	${DATACENTER_CONF_MAN5_SOURCES}		\
	${QM_CONF_MAN5_SOURCES}			\
	${PCT_CONF_MAN5_SOURCES}		\
	${SYSADMIN_SOURCES}			\
	pve-admin-guide.adoc			\
	pve-intro.adoc				\
	getting-help.adoc			\
	${INSTALLATION_SOURCES}			\
	pmxcfs.adoc 				\
	pmxcfs.8-cli.adoc			\
	pve-faq.adoc				\
	${PVE_FIREWALL_MAN8_SOURCES}		\
	${PVESM_MAN1_SOURCES}			\
	${PCT_MAN1_SOURCES}			\
	${PVECM_MAN1_SOURCES}			\
	${PVEUM_MAN1_SOURCES}			\
	${QM_MAN1_SOURCES}			\
	${QMRESTORE_MAN1_SOURCES}		\
	${HA_MANAGER_MAN1_SOURCES}		\
	${PVESTATD_MAN8_SOURCES}		\
	${PVEDAEMON_MAN8_SOURCES}		\
	${PVEPROXY_MAN8_SOURCES}		\
	${SPICEPROXY_MAN8_SOURCES}		\
	${PVE_HA_CRM_MAN8_SOURCES}		\
	${PVE_HA_LRM_MAN8_SOURCES}		\
	${VZDUMP_MAN1_SOURCES}			\
	${PVEAM_MAN1_SOURCES}			\
	${PVESUBSCRIPTION_MAN1_SOURCES}		\
	${PVECEPH_MAN1_SOURCES}			\
	${PVEPERF_MAN1_SOURCES}			\
	pve-bibliography.adoc			\
	$(addsuffix .adoc, ${COMMAND_LIST}) 	\
	$(addsuffix .adoc, ${SERVICE_LIST}) 	\
	$(addsuffix .adoc, ${CONFIG_LIST}) 	\
	GFDL.adoc				\
	attributes.txt

link-refs.json: scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES}
	./scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES} >link-refs.json

asciidoc-pve: asciidoc-pve.in link-refs.json
	cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
	sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
	chmod +x asciidoc-pve.tmp
	mv asciidoc-pve.tmp asciidoc-pve

pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
	cat pve-docs-mediawiki-import.in link-refs.json >  pve-docs-mediawiki-import.tmp
	chmod +x pve-docs-mediawiki-import.tmp
	mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import

test: asciidoc-pve
	./asciidoc-pve compile-wiki-section pve-package-repos.adoc
	#./asciidoc-pve compile-wiki-chapter ha-manager.adoc

WIKI_IMPORTS=									\
	pve-usbstick-plain.html							\
	getting-help-plain.html							\
	pve-system-requirements-plain.html					\
	$(addsuffix -plain.html, ${SYSADMIN_PARTS}) 				\
	$(addsuffix -plain.html, ${CHAPTER_LIST})				\
	$(addsuffix .5-plain.html, ${CONFIG_LIST})				\
	$(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES}))

INDEX_INCLUDES=								\
	pve-admin-guide.pdf 						\
	pve-admin-guide.html 						\
	pve-admin-guide.epub 						\
	$(addsuffix .1.html, ${COMMAND_LIST}) 				\
	$(addsuffix .8.html, ${SERVICE_LIST}) 				\
	$(addsuffix .5.html, ${CONFIG_LIST}) 				\
	$(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))

ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG}
ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG}
ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG}

BROWSER?=xdg-open

all: index.html

%-nwdiag.svg: %.nwdiag
	nwdiag -T svg $*.nwdiag -o $@;

%-plain.html: asciidoc-pve %.adoc
	./asciidoc-pve compile-wiki -o $@ $*.adoc

chapter-sysadmin.html sysadmin-plain.html: ${SYSADMIN_SOURCES}

chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc

%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc

pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc

%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc

%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc

%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc

README.html: README.adoc
	asciidoc ${ADOC_STDARG} -o $@ $<

.PHONY: index
index: index.html
	$(BROWSER) index.html &

index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} 
	asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc

pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
	asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc

pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
	rm -rf pve-admin-guide.chunked
	a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc

pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
	inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
	inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
	grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in  pve-admin-guide-docinfo.xml" && false);
	a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" --dblatex-opts "-P doc.section.depth=2 -P toc.section.depth=2" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc-dblatex-custom.sty" pve-admin-guide.adoc
	rm proxmox-logo.pdf proxmox-ci-header.pdf

pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
	a2x -f epub pve-admin-guide.adoc

api-viewer/apidata.js: extractapi.pl
	./extractapi.pl >$@

api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
	cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@

.PHONY: dinstall
dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
	dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}

.PHONY: deb
deb:
	rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
	make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};

${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import
	rm -rf build
	mkdir build
	rsync -a debian/ build/debian
	cp pve-docs-mediawiki-import build/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import
	echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
	# install files for pve-doc-generator package
	mkdir -p build/usr/share/${GEN_PACKAGE}
	mkdir -p build/usr/share/doc/${GEN_PACKAGE}
	install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
	install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
	# install files for pvedocs package
	mkdir -p build/usr/share/${DOC_PACKAGE}
	mkdir -p build/usr/share/doc/${DOC_PACKAGE}
	install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE}
	install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE}
	# install api doc viewer
	mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
	install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
	# build Debian packages
	cd build; dpkg-buildpackage -rfakeroot -b -us -uc
	lintian ${GEN_DEB}
	lintian ${DOC_DEB}
	lintian ${MEDIAWIKI_DEB}

.PHONY: upload
upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
	tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} | ssh repoman@repo.proxmox.com upload

.PHONY: update
update: clean
	rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc
	rm -f api-viewer/apidata.js
	rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
	make all

clean: 
	rm -rf *.tmp.xml *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import
	find . -name '*~' -exec rm {} ';'
Commit	Line	Data
bef0c1b4 DM	1	DGDIR=.
	2
	3	include ./pve-doc-generator.mk
deb7f2ea	4
9015f48f DM	5	GEN_PACKAGE=pve-doc-generator
9015f48f DM	6	DOC_PACKAGE=pve-docs
cfabc2e9	7	MEDIAWIKI_PACKAGE=pve-docs-mediawiki
9344ee0d DM	8
9344ee0d DM	9	# also update debian/changelog
145ee03a	10	PKGREL=5
9344ee0d	11
b4f3c18a DM	12	GITVERSION:=$(shell cat .git/refs/heads/master)
b4f3c18a DM	13
0a3c58e0 TL	14	ARCH:=$(shell dpkg-architecture -qDEB_BUILD_ARCH)
	15
	16	GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb
ceb4ea5b	17	DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
cfabc2e9	18	MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb
9344ee0d	19
f96bdfd8	20	CHAPTER_LIST= \
6b5fc47b	21	pve-installation \
f96bdfd8 DM	22	sysadmin \
	23	pvecm \
	24	pmxcfs \
	25	pvesm \
	26	qm \
	27	pve-firewall \
	28	pveum \
	29	pct \
	30	ha-manager \
	31	vzdump \
	32	pve-faq \
	33	pve-bibliography
	34
251666be DM	35	STORAGE_TYPES= \
	36	dir \
	37	glusterfs \
	38	iscsi \
	39	iscsidirect \
	40	lvm \
	41	lvmthin \
	42	nfs \
	43	rbd \
	44	zfspool
f96bdfd8	45
ebd2a7fb DM	46	COMMAND_LIST= \
	47	pvesubscription \
	48	pvecm \
	49	qm \
	50	qmrestore \
0840a663	51	pveceph \
ebd2a7fb DM	52	pct \
	53	pveam \
	54	pvesm \
	55	pveum \
	56	vzdump \
fcace69a FG	57	ha-manager \
fcace69a FG	58	pveperf
672abac1	59
96f2beeb DM	60	SERVICE_LIST= \
	61	pve-firewall \
	62	pve-ha-crm \
	63	pve-ha-lrm \
	64	pvestatd \
	65	pmxcfs \
	66	pveproxy \
2d8f1c92	67	spiceproxy \
96f2beeb	68	pvedaemon
672abac1 DM	69
	70	CONFIG_LIST=datacenter.cfg qm.conf pct.conf
	71
9015f48f	72	GEN_DEB_SOURCES= \
672abac1 DM	73	pve-doc-generator.mk \
	74	attributes.txt \
	75	$(addsuffix .adoc, ${COMMAND_LIST}) \
	76	$(addsuffix .adoc, ${SERVICE_LIST}) \
	77	$(addsuffix .adoc, ${CONFIG_LIST}) \
	78	pve-storage-dir.adoc \
	79	pve-storage-glusterfs.adoc \
	80	pve-storage-iscsi.adoc \
	81	pve-storage-iscsidirect.adoc \
	82	pve-storage-lvm.adoc \
82141a78	83	pve-storage-lvmthin.adoc \
672abac1 DM	84	pve-storage-nfs.adoc \
	85	pve-storage-rbd.adoc \
	86	pve-storage-zfspool.adoc \
bd88f9d9	87	pmxcfs.8-cli.adoc \
672abac1	88	pve-copyright.adoc \
9344ee0d DM	89	docinfo.xml
	90
	91	GEN_SCRIPTS= \
f6b81378 DM	92	gen-datacenter.cfg.5-opts.pl \
f6b81378 DM	93	gen-pct.conf.5-opts.pl \
bac8c385	94	gen-pct-network-opts.pl \
fe154a4f	95	gen-pct-mountpoint-opts.pl \
9b4799ab	96	gen-qm.conf.5-opts.pl \
500f1e1f	97	gen-vzdump.conf.5-opts.pl \
9344ee0d DM	98	gen-pve-firewall-cluster-opts.pl \
	99	gen-pve-firewall-host-opts.pl \
	100	gen-pve-firewall-macros-adoc.pl \
	101	gen-pve-firewall-rules-opts.pl \
f6b81378	102	gen-pve-firewall-vm-opts.pl
9344ee0d	103
6b5fc47b	104	INSTALLATION_SOURCES= \
5c6cf7ac	105	pve-usbstick.adoc \
bc1c71d4	106	pve-system-requirements.adoc \
6b5fc47b DM	107	pve-installation.adoc
6b5fc47b DM	108
8c80c3fc	109	SYSADMIN_PARTS= \
8c80c3fc DM	110	pve-network \
8c80c3fc DM	111	pve-package-repos \
8c80c3fc	112	system-software-updates \
897abbde	113	pve-disk-health-monitoring \
8b849dc3	114	local-lvm \
8c80c3fc DM	115	local-zfs
8c80c3fc DM	116
672abac1	117	SYSADMIN_SOURCES= \
8c80c3fc	118	$(addsuffix .adoc, ${SYSADMIN_PARTS}) \
d91f8c1e DM	119	sysadmin.adoc
d91f8c1e DM	120
356064f4 DM	121	API_VIEWER_SOURCES= \
	122	api-viewer/index.html \
	123	api-viewer/apidoc.js
	124
672abac1 DM	125	PVE_ADMIN_GUIDE_SOURCES= \
	126	${DATACENTER_CONF_MAN5_SOURCES} \
	127	${QM_CONF_MAN5_SOURCES} \
	128	${PCT_CONF_MAN5_SOURCES} \
	129	${SYSADMIN_SOURCES} \
	130	pve-admin-guide.adoc \
	131	pve-intro.adoc \
86f58817	132	getting-help.adoc \
6b5fc47b	133	${INSTALLATION_SOURCES} \
672abac1	134	pmxcfs.adoc \
bd88f9d9	135	pmxcfs.8-cli.adoc \
672abac1 DM	136	pve-faq.adoc \
	137	${PVE_FIREWALL_MAN8_SOURCES} \
	138	${PVESM_MAN1_SOURCES} \
	139	${PCT_MAN1_SOURCES} \
	140	${PVECM_MAN1_SOURCES} \
	141	${PVEUM_MAN1_SOURCES} \
	142	${QM_MAN1_SOURCES} \
	143	${QMRESTORE_MAN1_SOURCES} \
	144	${HA_MANAGER_MAN1_SOURCES} \
2d8f1c92 DM	145	${PVESTATD_MAN8_SOURCES} \
	146	${PVEDAEMON_MAN8_SOURCES} \
	147	${PVEPROXY_MAN8_SOURCES} \
	148	${SPICEPROXY_MAN8_SOURCES} \
672abac1 DM	149	${PVE_HA_CRM_MAN8_SOURCES} \
672abac1 DM	150	${PVE_HA_LRM_MAN8_SOURCES} \
6198e7c5 DM	151	${VZDUMP_MAN1_SOURCES} \
6198e7c5 DM	152	${PVEAM_MAN1_SOURCES} \
ebd2a7fb	153	${PVESUBSCRIPTION_MAN1_SOURCES} \
0840a663	154	${PVECEPH_MAN1_SOURCES} \
fcace69a	155	${PVEPERF_MAN1_SOURCES} \
672abac1 DM	156	pve-bibliography.adoc \
	157	$(addsuffix .adoc, ${COMMAND_LIST}) \
	158	$(addsuffix .adoc, ${SERVICE_LIST}) \
	159	$(addsuffix .adoc, ${CONFIG_LIST}) \
	160	GFDL.adoc \
deb7f2ea DM	161	attributes.txt
deb7f2ea DM	162
aa99b349 DM	163	link-refs.json: scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES}
	164	./scan-adoc-refs ${PVE_ADMIN_GUIDE_SOURCES} >link-refs.json
	165
	166	asciidoc-pve: asciidoc-pve.in link-refs.json
	167	cat asciidoc-pve.in link-refs.json >asciidoc-pve.tmp
835dd63b	168	sed -e s/@RELEASE@/${DOCRELEASE}/ -i asciidoc-pve.tmp
aa99b349 DM	169	chmod +x asciidoc-pve.tmp
	170	mv asciidoc-pve.tmp asciidoc-pve
	171
b489b02c DM	172	pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json
	173	cat pve-docs-mediawiki-import.in link-refs.json > pve-docs-mediawiki-import.tmp
	174	chmod +x pve-docs-mediawiki-import.tmp
	175	mv pve-docs-mediawiki-import.tmp pve-docs-mediawiki-import
	176
835dd63b DM	177	test: asciidoc-pve
	178	./asciidoc-pve compile-wiki-section pve-package-repos.adoc
	179	#./asciidoc-pve compile-wiki-chapter ha-manager.adoc
	180
8c80c3fc	181	WIKI_IMPORTS= \
b489b02c DM	182	pve-usbstick-plain.html \
	183	getting-help-plain.html \
	184	pve-system-requirements-plain.html \
	185	$(addsuffix -plain.html, ${SYSADMIN_PARTS}) \
	186	$(addsuffix -plain.html, ${CHAPTER_LIST}) \
8c80c3fc	187	$(addsuffix .5-plain.html, ${CONFIG_LIST}) \
251666be DM	188	$(addsuffix -plain.html, $(addprefix pve-storage-, ${STORAGE_TYPES}))
251666be DM	189
f4defaeb DM	190	INDEX_INCLUDES= \
	191	pve-admin-guide.pdf \
	192	pve-admin-guide.html \
	193	pve-admin-guide.epub \
	194	$(addsuffix .1.html, ${COMMAND_LIST}) \
	195	$(addsuffix .8.html, ${SERVICE_LIST}) \
	196	$(addsuffix .5.html, ${CONFIG_LIST}) \
251666be	197	$(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
f4defaeb	198
0e25828e DM	199	ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}"
	200	ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG}
	201	ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG}
	202	ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG}
deb7f2ea	203
fc1090ef	204	BROWSER?=xdg-open
df41beec	205
56122987	206	all: index.html
7b2c36ae	207
deb7f2ea DM	208	%-nwdiag.svg: %.nwdiag
	209	nwdiag -T svg $*.nwdiag -o $@;
	210
b489b02c DM	211	%-plain.html: asciidoc-pve %.adoc
b489b02c DM	212	./asciidoc-pve compile-wiki -o $@ $*.adoc
5c6cf7ac	213
b489b02c	214	chapter-sysadmin.html sysadmin-plain.html: ${SYSADMIN_SOURCES}
9ee94323	215
f96bdfd8	216	chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
d01fa25d	217	asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc
f96bdfd8	218
bd88f9d9	219	%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea	220	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
deb7f2ea	221
7c40c631 DM	222	pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
7c40c631 DM	223	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
deb7f2ea	224
7c40c631	225	%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea	226	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
71e16346	227
7c40c631	228	%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
c016ebb7	229	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
c016ebb7	230
1496dbe5 DM	231	%.5-plain.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
1496dbe5 DM	232	asciidoc -s ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
1496dbe5	233
9d17dbac DM	234	README.html: README.adoc
	235	asciidoc ${ADOC_STDARG} -o $@ $<
	236
8ace7110 DM	237	.PHONY: index
8ace7110 DM	238	index: index.html
3f559975 DM	239	$(BROWSER) index.html &
3f559975 DM	240
f4defaeb	241	index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES}
bef0c1b4	242	asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
deb7f2ea DM	243
deb7f2ea DM	244	pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
683e3b93	245	asciidoc -a pvelogo -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
deb7f2ea	246
59d89a51 DM	247	pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
	248	rm -rf pve-admin-guide.chunked
	249	a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
59d89a51	250
66f81679	251	pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
34ef065a	252	inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg
333a2f49	253	inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg
bef0c1b4	254	grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml \|\| (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
72470ed6	255	a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" --dblatex-opts "-P doc.section.depth=2 -P toc.section.depth=2" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc-dblatex-custom.sty" pve-admin-guide.adoc
34ef065a	256	rm proxmox-logo.pdf proxmox-ci-header.pdf
deb7f2ea DM	257
	258	pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
	259	a2x -f epub pve-admin-guide.adoc
9344ee0d	260
356064f4	261	api-viewer/apidata.js: extractapi.pl
61568a65 DM	262	./extractapi.pl >$@
61568a65 DM	263
356064f4 DM	264	api-viewer/apidoc.js: api-viewer/apidata.js api-viewer/PVEAPI.js
356064f4 DM	265	cat api-viewer/apidata.js api-viewer/PVEAPI.js >$@
61568a65	266
9344ee0d	267	.PHONY: dinstall
cfabc2e9 DM	268	dinstall: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
cfabc2e9 DM	269	dpkg -i ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
9015f48f	270
9344ee0d	271	.PHONY: deb
9015f48f	272	deb:
cfabc2e9 DM	273	rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
cfabc2e9 DM	274	make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB};
9015f48f	275
b489b02c	276	${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import
9015f48f DM	277	rm -rf build
9015f48f DM	278	mkdir build
ceb4ea5b	279	rsync -a debian/ build/debian
b489b02c	280	cp pve-docs-mediawiki-import build/debian/tree/pve-docs-mediawiki/pve-docs-mediawiki-import
ceb4ea5b DM	281	echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/debian/SOURCE
	282	# install files for pve-doc-generator package
	283	mkdir -p build/usr/share/${GEN_PACKAGE}
	284	mkdir -p build/usr/share/doc/${GEN_PACKAGE}
	285	install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE}
	286	install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE}
	287	# install files for pvedocs package
9015f48f DM	288	mkdir -p build/usr/share/${DOC_PACKAGE}
9015f48f DM	289	mkdir -p build/usr/share/doc/${DOC_PACKAGE}
ad2bfc41	290	install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE}
251666be	291	install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE}
61568a65	292	# install api doc viewer
356064f4 DM	293	mkdir build/usr/share/${DOC_PACKAGE}/api-viewer
356064f4 DM	294	install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer
cfabc2e9	295	# build Debian packages
9344ee0d	296	cd build; dpkg-buildpackage -rfakeroot -b -us -uc
9015f48f	297	lintian ${GEN_DEB}
ceb4ea5b	298	lintian ${DOC_DEB}
cfabc2e9	299	lintian ${MEDIAWIKI_DEB}
9344ee0d	300
89e93b38	301	.PHONY: upload
cfabc2e9	302	upload: ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}
d7b4925a	303	tar cf - ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB} \| ssh repoman@repo.proxmox.com upload
deb7f2ea	304
56122987	305	.PHONY: update
c016ebb7	306	update: clean
7aacca6f	307	rm -f .5-opts.adoc .1-synopsis.adoc *.8-synopsis.adoc
56122987	308	rm -f api-viewer/apidata.js
fe154a4f	309	rm -f pve-firewall-macros.adoc pct-network-opts.adoc pct-mountpoint-opts.adoc
c016ebb7	310	make all
deb7f2ea	311
bca311e4	312	clean:
b489b02c	313	rm -rf .tmp.xml .html .pdf .epub .tmp .1 .5 .8 .deb .changes build api-viewer/apidoc.js chapter-.html -plain.html chapter-.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_ pve-docs-mediawiki-import
de9cbbd6	314	find . -name '*~' -exec rm {} ';'