[pve-docs.git] / Makefile

DGDIR=.

include ./pve-doc-generator.mk

PACKAGE=pve-doc-generator

# also update debian/changelog
PKGREL=1

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


DEB_SOURCES=			\
	pve-doc-generator.mk	\
	attributes.txt		\
	pvesm.adoc		\
	pveum.adoc		\
	vzdump.adoc		\
	pve-firewall.adoc	\
	qm.adoc			\
	pct.adoc		\
	pveam.adoc		\
	ha-manager.adoc		\
	pve-copyright.adoc	\
	docinfo.xml

GEN_SCRIPTS=					\
	gen-datacenter-cfg-opts-adoc.pl		\
	gen-pct-conf-opts-adoc.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		\
	gen-vm-conf-opts-adoc.pl

PVESM_SOURCES=attributes.txt pvesm.adoc pvesm.1-synopsis.adoc $(shell ls pve-storage-*.adoc)
PVEUM_SOURCES=attributes.txt pveum.adoc pveum.1-synopsis.adoc
VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
QM_SOURCES=attributes.txt qm.adoc qm.1-synopsis.adoc
PCT_SOURCES=attributes.txt pct.adoc pct.1-synopsis.adoc
PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc
HA_SOURCES=attributes.txt ha-manager.1-synopsis.adoc ha-manager.adoc

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

PVE_ADMIN_GUIDE_SOURCES=		\
	datacenter.cfg.adoc		\
	datacenter.cfg.5-opts.adoc	\
	vm.conf.adoc			\
	vm.conf.5-opts.adoc		\
	pct.conf.adoc			\
	pct.conf.5-opts.adoc		\
	${SYSADMIN_SOURCES}		\
	pve-admin-guide.adoc		\
	pve-intro.adoc			\
	pmxcfs.adoc 			\
	pve-faq.adoc			\
	${PVE_FIREWALL_MAN8_SOURCES}	\
	${QM_SOURCES}			\
	${PCT_SOURCES}			\
	${PVEAM_SOURCES}		\
	${PVEUM_SOURCES}		\
	${PVESM_SOURCES}		\
	${VZDUMP_SOURCES}		\
	${HA_SOURCES}			\
	images/cluster-nwdiag.svg	\
	images/node-nwdiag.svg		\
	pve-bibliography.adoc		\
	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: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
	test -n "$${NOVIEW}" || man -l $@

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


%.8-synopsis.adoc:
	perl -e "use PVE::Service::$(subst -,_,$*);print PVE::Service::$(subst -,_,$*)->generate_asciidoc_synopsys();" > $@.tmp
	mv $@.tmp $@

%.8: %.adoc %.8-synopsis.adoc docinfo.xml
	a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
	test -n "$${NOVIEW}" || man -l $@

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

%.5: %.adoc %.5-opts.adoc docinfo.xml
	a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
	test -n "$${NOVIEW}" || man -l $@

%.5.html: %.adoc %.5-opts.adoc docinfo.xml
	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 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html
	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}
	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}


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
bef0c1b4	10	DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
9344ee0d DM	11
	12
	13	DEB_SOURCES= \
	14	pve-doc-generator.mk \
	15	attributes.txt \
	16	pvesm.adoc \
	17	pveum.adoc \
	18	vzdump.adoc \
	19	pve-firewall.adoc \
	20	qm.adoc \
	21	pct.adoc \
	22	pveam.adoc \
	23	ha-manager.adoc \
	24	pve-copyright.adoc \
	25	docinfo.xml
	26
	27	GEN_SCRIPTS= \
	28	gen-datacenter-cfg-opts-adoc.pl \
	29	gen-pct-conf-opts-adoc.pl \
	30	gen-pve-firewall-cluster-opts.pl \
	31	gen-pve-firewall-host-opts.pl \
	32	gen-pve-firewall-macros-adoc.pl \
	33	gen-pve-firewall-rules-opts.pl \
	34	gen-pve-firewall-vm-opts.pl \
	35	gen-vm-conf-opts-adoc.pl
	36
deb7f2ea DM	37	PVESM_SOURCES=attributes.txt pvesm.adoc pvesm.1-synopsis.adoc $(shell ls pve-storage-*.adoc)
	38	PVEUM_SOURCES=attributes.txt pveum.adoc pveum.1-synopsis.adoc
	39	VZDUMP_SOURCES=attributes.txt vzdump.adoc vzdump.1-synopsis.adoc
deb7f2ea DM	40	QM_SOURCES=attributes.txt qm.adoc qm.1-synopsis.adoc
deb7f2ea DM	41	PCT_SOURCES=attributes.txt pct.adoc pct.1-synopsis.adoc
d61bab51	42	PVEAM_SOURCES=attributes.txt pveam.adoc pveam.1-synopsis.adoc
22653ac8	43	HA_SOURCES=attributes.txt ha-manager.1-synopsis.adoc ha-manager.adoc
deb7f2ea	44
d91f8c1e DM	45	SYSADMIN_SOURCES= \
	46	getting-help.adoc \
	47	pve-package-repos.adoc \
	48	pve-installation.adoc \
	49	system-software-updates.adoc \
	50	sysadmin.adoc
	51
deb7f2ea	52	PVE_ADMIN_GUIDE_SOURCES= \
c016ebb7 DM	53	datacenter.cfg.adoc \
c016ebb7 DM	54	datacenter.cfg.5-opts.adoc \
7b2c36ae DM	55	vm.conf.adoc \
7b2c36ae DM	56	vm.conf.5-opts.adoc \
71e16346 DM	57	pct.conf.adoc \
71e16346 DM	58	pct.conf.5-opts.adoc \
d91f8c1e	59	${SYSADMIN_SOURCES} \
deb7f2ea DM	60	pve-admin-guide.adoc \
	61	pve-intro.adoc \
	62	pmxcfs.adoc \
	63	pve-faq.adoc \
9344ee0d	64	${PVE_FIREWALL_MAN8_SOURCES} \
deb7f2ea DM	65	${QM_SOURCES} \
deb7f2ea DM	66	${PCT_SOURCES} \
d61bab51	67	${PVEAM_SOURCES} \
deb7f2ea DM	68	${PVEUM_SOURCES} \
	69	${PVESM_SOURCES} \
	70	${VZDUMP_SOURCES} \
22653ac8	71	${HA_SOURCES} \
deb7f2ea DM	72	images/cluster-nwdiag.svg \
	73	images/node-nwdiag.svg \
	74	pve-bibliography.adoc \
caf01dfc	75	GFDL.adoc \
deb7f2ea DM	76	attributes.txt
	77
	78	ADOC_STDARG= -a icons -a data-uri -a "date=$(shell date)"
bef0c1b4 DM	79	ADOC_MAN1_HTML_ARGS=-a "manvolnum=1" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
	80	ADOC_MAN5_HTML_ARGS=-a "manvolnum=5" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
	81	ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
deb7f2ea	82
fc1090ef	83	BROWSER?=xdg-open
df41beec	84
7b2c36ae DM	85	all: pve-admin-guide.html
7b2c36ae DM	86
deb7f2ea DM	87	%-nwdiag.svg: %.nwdiag
	88	nwdiag -T svg $*.nwdiag -o $@;
	89
bef0c1b4 DM	90	%.1: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
bef0c1b4 DM	91	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
9344ee0d	92	test -n "$${NOVIEW}" \|\| man -l $@
deb7f2ea	93
bef0c1b4	94	%.1.html: %.adoc %.1-synopsis.adoc docinfo.xml attributes.txt
deb7f2ea	95	asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
9344ee0d	96	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea DM	97
	98
	99	%.8-synopsis.adoc:
	100	perl -e "use PVE::Service::$(subst -,_,$);print PVE::Service::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	101	mv $@.tmp $@
	102
	103	%.8: %.adoc %.8-synopsis.adoc docinfo.xml
bef0c1b4	104	a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
9344ee0d	105	test -n "$${NOVIEW}" \|\| man -l $@
deb7f2ea DM	106
	107	%.8.html: %.adoc %.8-synopsis.adoc docinfo.xml
	108	asciidoc ${ADOC_MAN8_HTML_ARGS} -o $@ $*.adoc
9344ee0d	109	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
71e16346	110
c016ebb7	111	%.5: %.adoc %.5-opts.adoc docinfo.xml
bef0c1b4	112	a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
9344ee0d	113	test -n "$${NOVIEW}" \|\| man -l $@
c016ebb7 DM	114
	115	%.5.html: %.adoc %.5-opts.adoc docinfo.xml
	116	asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
9344ee0d	117	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
c016ebb7	118
deb7f2ea DM	119	index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES}
deb7f2ea DM	120	$(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
71e16346	121	$(MAKE) NOVIEW=1 qm.1.html pct.1.html pveam.1.html pvesm.1.html pveum.1.html vzdump.1.html pve-firewall.8.html ha-manager.1.html datacenter.cfg.5.html vm.conf.5.html pct.conf.5.html
bef0c1b4	122	asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
9344ee0d	123	test -n "$${NOVIEW}" \|\| $(BROWSER) index.html &
deb7f2ea DM	124
deb7f2ea DM	125	pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
bef0c1b4	126	asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
9344ee0d	127	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea	128
2296c490	129	pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
bef0c1b4	130	grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml \|\| (echo "wrong release in pve-admin-guide-docinfo.xml" && false);
27125931	131	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	132	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
deb7f2ea DM	133
	134	pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_SOURCES}
	135	a2x -f epub pve-admin-guide.adoc
9344ee0d DM	136	test -n "$${NOVIEW}" \|\| $(BROWSER) $@ &
	137
	138	.PHONY: dinstall
	139	dinstall: ${DEB}
	140	dpkg -i ${DEB}
	141
	142	.PHONY: deb
	143	${DEB} deb:
	144	rm -rf build
	145	mkdir build
	146	rsync -a debian/ build/debian
	147	mkdir -p build/usr/share/${PACKAGE}
	148	install -m 0644 ${DEB_SOURCES} build/usr/share/${PACKAGE}
	149	install -m 0755 ${GEN_SCRIPTS} build/usr/share/${PACKAGE}
	150	cd build; dpkg-buildpackage -rfakeroot -b -us -uc
	151	lintian ${DEB}
	152
deb7f2ea	153
c016ebb7 DM	154	update: clean
	155	rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
	156	make all
deb7f2ea DM	157
deb7f2ea DM	158	clean:
9344ee0d DM	159	rm -rf ~ .html .pdf .epub .tmp .1 .5 .8 .deb .changes build
9344ee0d DM	160