[pve-docs.git] / Makefile

DGDIR=.

include ./pve-doc-generator.mk

PACKAGE=pve-doc-generator

# also update debian/changelog
PKGREL=1

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

DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb

COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager

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

CONFIG_LIST=datacenter.cfg qm.conf pct.conf

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-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-qm.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

VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc

SYSADMIN_SOURCES=				\
	getting-help.adoc			\
	pve-package-repos.adoc			\
	pve-installation.adoc			\
	system-software-updates.adoc		\
	sysadmin.adoc

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				\
	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}		\
	${PVE_HA_CRM_MAN8_SOURCES}		\
	${PVE_HA_LRM_MAN8_SOURCES}		\
	${PVEAM_SOURCES}			\
	${VZDUMP_SOURCES}			\
	images/cluster-nwdiag.svg		\
	images/node-nwdiag.svg			\
	pve-bibliography.adoc			\
	$(addsuffix .adoc, ${COMMAND_LIST}) 	\
	$(addsuffix .adoc, ${SERVICE_LIST}) 	\
	$(addsuffix .adoc, ${CONFIG_LIST}) 	\
	GFDL.adoc				\
	attributes.txt

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

BROWSER?=xdg-open

all: pve-admin-guide.html

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

%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &


pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &

%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &

%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &

index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES}
	$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
	$(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
	asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
	test -n "$${NOVIEW}" || $(BROWSER) index.html &

pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
	asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &

pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
	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" pve-admin-guide.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &

pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
	a2x -f epub pve-admin-guide.adoc
	test -n "$${NOVIEW}" || $(BROWSER) $@ &

.PHONY: dinstall
dinstall: ${DEB}
	dpkg -i ${DEB}

.PHONY: deb
${DEB} deb:
	rm -rf build
	mkdir build
	rsync -a debian/ build/debian
	mkdir -p build/usr/share/${PACKAGE}
	mkdir -p build/usr/share/doc/${PACKAGE}
	echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${PACKAGE}/SOURCE
	install -m 0644 ${DEB_SOURCES} build/usr/share/${PACKAGE}
	install -m 0755 ${GEN_SCRIPTS} build/usr/share/${PACKAGE}
	cd build; dpkg-buildpackage -rfakeroot -b -us -uc
	lintian ${DEB}

.PHONY: upload
upload: ${DEB}
	umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw
	mkdir -p /pve/${DOCRELEASE}/extra
	rm -f /pve/${DOCRELEASE}/extra/${PACKAGE}_*.deb
	rm -f /pve/${DOCRELEASE}/extra/Packages*
	cp ${DEB} /pve/${DOCRELEASE}/extra
	cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz
	umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro

update: clean
	rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
	make all

clean:
	rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build
Commit	Line	Data
bef0c1b4 DM	1	DGDIR=.
	2
	3	include ./pve-doc-generator.mk
deb7f2ea	4
9344ee0d DM	5	PACKAGE=pve-doc-generator
	6
	7	# also update debian/changelog
	8	PKGREL=1
	9
b4f3c18a DM	10	GITVERSION:=$(shell cat .git/refs/heads/master)
b4f3c18a DM	11
bef0c1b4	12	DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
9344ee0d	13
672abac1 DM	14	COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager
672abac1 DM	15
96f2beeb DM	16	SERVICE_LIST= \
	17	pve-firewall \
	18	pve-ha-crm \
	19	pve-ha-lrm \
	20	pvestatd \
	21	pmxcfs \
	22	pveproxy \
	23	pvedaemon
672abac1 DM	24
	25	CONFIG_LIST=datacenter.cfg qm.conf pct.conf
	26
	27	DEB_SOURCES= \
	28	pve-doc-generator.mk \
	29	attributes.txt \
	30	$(addsuffix .adoc, ${COMMAND_LIST}) \
	31	$(addsuffix .adoc, ${SERVICE_LIST}) \
	32	$(addsuffix .adoc, ${CONFIG_LIST}) \
	33	pve-storage-dir.adoc \
	34	pve-storage-glusterfs.adoc \
	35	pve-storage-iscsi.adoc \
	36	pve-storage-iscsidirect.adoc \
	37	pve-storage-lvm.adoc \
	38	pve-storage-nfs.adoc \
	39	pve-storage-rbd.adoc \
	40	pve-storage-zfspool.adoc \
bd88f9d9	41	pmxcfs.8-cli.adoc \
672abac1	42	pve-copyright.adoc \
9344ee0d DM	43	docinfo.xml
	44
	45	GEN_SCRIPTS= \
f6b81378 DM	46	gen-datacenter.cfg.5-opts.pl \
f6b81378 DM	47	gen-pct.conf.5-opts.pl \
9b4799ab	48	gen-qm.conf.5-opts.pl \
9344ee0d DM	49	gen-pve-firewall-cluster-opts.pl \
	50	gen-pve-firewall-host-opts.pl \
	51	gen-pve-firewall-macros-adoc.pl \
	52	gen-pve-firewall-rules-opts.pl \
f6b81378	53	gen-pve-firewall-vm-opts.pl
9344ee0d	54
deb7f2ea	55	VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
d61bab51	56	PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc
deb7f2ea	57
672abac1 DM	58	SYSADMIN_SOURCES= \
	59	getting-help.adoc \
	60	pve-package-repos.adoc \
	61	pve-installation.adoc \
	62	system-software-updates.adoc \
d91f8c1e DM	63	sysadmin.adoc
d91f8c1e DM	64
672abac1 DM	65	PVE_ADMIN_GUIDE_SOURCES= \
	66	${DATACENTER_CONF_MAN5_SOURCES} \
	67	${QM_CONF_MAN5_SOURCES} \
	68	${PCT_CONF_MAN5_SOURCES} \
	69	${SYSADMIN_SOURCES} \
	70	pve-admin-guide.adoc \
	71	pve-intro.adoc \
	72	pmxcfs.adoc \
bd88f9d9	73	pmxcfs.8-cli.adoc \
672abac1 DM	74	pve-faq.adoc \
	75	${PVE_FIREWALL_MAN8_SOURCES} \
	76	${PVESM_MAN1_SOURCES} \
	77	${PCT_MAN1_SOURCES} \
	78	${PVECM_MAN1_SOURCES} \
	79	${PVEUM_MAN1_SOURCES} \
	80	${QM_MAN1_SOURCES} \
	81	${QMRESTORE_MAN1_SOURCES} \
	82	${HA_MANAGER_MAN1_SOURCES} \
	83	${PVE_HA_CRM_MAN8_SOURCES} \
	84	${PVE_HA_LRM_MAN8_SOURCES} \
	85	${PVEAM_SOURCES} \
	86	${VZDUMP_SOURCES} \
	87	images/cluster-nwdiag.svg \
	88	images/node-nwdiag.svg \
	89	pve-bibliography.adoc \
	90	$(addsuffix .adoc, ${COMMAND_LIST}) \
	91	$(addsuffix .adoc, ${SERVICE_LIST}) \
	92	$(addsuffix .adoc, ${CONFIG_LIST}) \
	93	GFDL.adoc \
deb7f2ea DM	94	attributes.txt
	95
	96	ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)"
bef0c1b4 DM	97	ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
	98	ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
	99	ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
deb7f2ea	100
fc1090ef	101	BROWSER?=xdg-open
df41beec	102
7b2c36ae DM	103	all: pve-admin-guide.html
7b2c36ae DM	104
deb7f2ea DM	105	%-nwdiag.svg: %.nwdiag
	106	nwdiag -T svg $*.nwdiag -o $@;
	107
bd88f9d9	108	%.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea	109	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
9344ee0d	110	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea DM	111
deb7f2ea DM	112
7c40c631 DM	113	pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
	114	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ pmxcfs.adoc
	115	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea	116
7c40c631	117	%.8.html: %.adoc %.8-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
deb7f2ea	118	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
9344ee0d	119	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
71e16346	120
7c40c631	121	%.5.html: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
c016ebb7	122	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
9344ee0d	123	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
c016ebb7	124
deb7f2ea DM	125	index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES}
deb7f2ea DM	126	$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
672abac1	127	$(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
bef0c1b4	128	asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
9344ee0d	129	test -n "$${NOVIEW}" \|\| $(BROWSER) index.html &
deb7f2ea DM	130
deb7f2ea DM	131	pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
bef0c1b4	132	asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
9344ee0d	133	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea	134
2296c490	135	pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
bef0c1b4	136	grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml \|\| (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
27125931	137	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" pve-admin-guide.adoc
9344ee0d	138	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea DM	139
	140	pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
	141	a2x -f epub pve-admin-guide.adoc
9344ee0d DM	142	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
	143
	144	.PHONY: dinstall
	145	dinstall: ${DEB}
	146	dpkg -i ${DEB}
	147
	148	.PHONY: deb
	149	${DEB} deb:
	150	rm -rf build
	151	mkdir build
	152	rsync -a debian/ build/debian
	153	mkdir -p build/usr/share/${PACKAGE}
b4f3c18a DM	154	mkdir -p build/usr/share/doc/${PACKAGE}
b4f3c18a DM	155	echo "git clone git://git.proxmox.com/git/pve-docs.git\\ngit checkout ${GITVERSION}" > build/usr/share/doc/${PACKAGE}/SOURCE
9344ee0d DM	156	install -m 0644 ${DEB_SOURCES} build/usr/share/${PACKAGE}
	157	install -m 0755 ${GEN_SCRIPTS} build/usr/share/${PACKAGE}
	158	cd build; dpkg-buildpackage -rfakeroot -b -us -uc
	159	lintian ${DEB}
	160
89e93b38 DM	161	.PHONY: upload
	162	upload: ${DEB}
	163	umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o rw
	164	mkdir -p /pve/${DOCRELEASE}/extra
	165	rm -f /pve/${DOCRELEASE}/extra/${PACKAGE}_*.deb
	166	rm -f /pve/${DOCRELEASE}/extra/Packages*
	167	cp ${DEB} /pve/${DOCRELEASE}/extra
	168	cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz
	169	umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro
deb7f2ea	170
c016ebb7 DM	171	update: clean
	172	rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
	173	make all
deb7f2ea DM	174
deb7f2ea DM	175	clean:
9344ee0d DM	176	rm -rf ~ .html .pdf .epub .tmp .1 .5 .8 .deb .changes build
9344ee0d DM	177