[pve-docs.git] / Makefile

DGDIR=.
ASCIIDOC_PVE=./asciidoc-pve

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 asciidoc-pve ${PVE_COMMON_DOC_SOURCES}
	./asciidoc-pve compile-chapter -o $@ $*.adoc

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