[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


DEB_SOURCES=			\
	pve-doc-generator.mk	\
	attributes.txt		\
	pvesm.adoc		\
	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	\
	pvecm.adoc			\
	pveum.adoc		\
	vzdump.adoc		\
	pve-firewall.adoc	\
	qm.adoc			\
	vm.conf.adoc		\
	pct.adoc		\
	pct.conf.adoc		\
	datacenter.cfg.adoc	\
	pveam.adoc		\
	ha-manager.adoc		\
	pve-copyright.adoc	\
	docinfo.xml

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