[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=3

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

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			\
	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}			\
	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
	chmod +x asciidoc-pve.tmp
	mv asciidoc-pve.tmp asciidoc-pve

WIKI_IMPORTS=									\
	section-pve-usbstick-plain.html						\
	section-getting-help-plain.html						\
	section-pve-system-requirements-plain.html				\
	$(addsuffix -plain.html, $(addprefix sysadmin-, ${SYSADMIN_PARTS})) 	\
	$(addsuffix -plain.html, $(addprefix chapter-, ${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 $@;

sysadmin-%-plain.html: %.adoc
	asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc

section-%-plain.html: %.adoc
	asciidoc -s -a wiki -a 'leveloffset=-1' ${ADOC_STDARG} -o $@ $*.adoc

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

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

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

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