[pve-docs.git] / pve-doc-generator.mk

# also update debian/changelog
DOCRELEASE=4.1

DGDIR?=/usr/share/pve-doc-generator

all:

PVE_COMMON_DOC_SOURCES=			\
	attributes.txt 			\
	pve-copyright.adoc		\
	docinfo.xml

PVECM_MAN1_SOURCES=			\
	pvecm.adoc			\
	pvecm.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVE_FIREWALL_MAN8_SOURCES=		\
	pve-firewall.adoc 		\
	pve-firewall.8-synopsis.adoc 	\
	pve-firewall-cluster-opts.adoc 	\
	pve-firewall-host-opts.adoc 	\
	pve-firewall-vm-opts.adoc 	\
	pve-firewall-rules-opts.adoc	\
	pve-firewall-macros.adoc	\
	${PVE_COMMON_DOC_SOURCES}

PVESM_MAN1_SOURCES=			\
	pvesm.adoc			\
	pvesm.1-synopsis.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	\
	${PVE_COMMON_DOC_SOURCES}

PCT_MAN1_SOURCES=			\
	pct.adoc 			\
	pct.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

QM_MAN1_SOURCES=			\
	qm.adoc 			\
	qm.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

PVEUM_MAN1_SOURCES=			\
	pveum.adoc 			\
	pveum.1-synopsis.adoc		\
	${PVE_COMMON_DOC_SOURCES}

attributes.txt docinfo.xml:
	cp ${DGDIR}/$@ $@.tmp
	mv $@.tmp $@

%-opts.adoc: ${DGDIR}/gen-%-opts.pl
	${DGDIR}/gen-$*-opts.pl >$@.tmp
	mv $@.tmp $@

%.adoc: ${DGDIR}/gen-%-adoc.pl
	${DGDIR}/gen-$*-adoc.pl >$@.tmp
	mv $@.tmp $@

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

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

ifneq (${DGDIR},.)
%.adoc: ${DGDIR}/%.adoc
	cp $< $@.tmp
	mv $@.tmp $@
endif

pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
	a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-firewall.adoc
	test -n "$${NOVIEW}" || man -l $@

pvesm.1: ${PVESM_MAN1_SOURCES}
	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvesm.adoc
	test -n "$${NOVIEW}" || man -l $@

pct.1: ${PCT_MAN1_SOURCES}
	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pct.adoc
	test -n "$${NOVIEW}" || man -l $@

qm.1: ${QM_MAN1_SOURCES}
	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage qm.adoc
	test -n "$${NOVIEW}" || man -l $@

pvecm.1: ${PVECM_MAN1_SOURCES}
	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvecm.adoc
	test -n "$${NOVIEW}" || man -l $@

pveum.1: ${PVEUM_MAN1_SOURCES}
	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pveum.adoc
	test -n "$${NOVIEW}" || man -l $@

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

.PHONY: cleanup-docgen
cleanup-docgen:
	rm -f *.1 *.8 *.adoc attributes.txt docinfo.xml
Commit	Line	Data
bef0c1b4 DM	1	# also update debian/changelog
	2	DOCRELEASE=4.1
	3
9344ee0d DM	4	DGDIR?=/usr/share/pve-doc-generator
	5
	6	all:
	7
828a27f5 DM	8	PVE_COMMON_DOC_SOURCES= \
	9	attributes.txt \
	10	pve-copyright.adoc \
	11	docinfo.xml
	12
d8742b0c DM	13	PVECM_MAN1_SOURCES= \
	14	pvecm.adoc \
	15	pvecm.1-synopsis.adoc \
	16	${PVE_COMMON_DOC_SOURCES}
	17
9344ee0d DM	18	PVE_FIREWALL_MAN8_SOURCES= \
	19	pve-firewall.adoc \
	20	pve-firewall.8-synopsis.adoc \
	21	pve-firewall-cluster-opts.adoc \
	22	pve-firewall-host-opts.adoc \
	23	pve-firewall-vm-opts.adoc \
	24	pve-firewall-rules-opts.adoc \
	25	pve-firewall-macros.adoc \
828a27f5 DM	26	${PVE_COMMON_DOC_SOURCES}
	27
	28	PVESM_MAN1_SOURCES= \
	29	pvesm.adoc \
	30	pvesm.1-synopsis.adoc \
	31	pve-storage-dir.adoc \
	32	pve-storage-glusterfs.adoc \
	33	pve-storage-iscsi.adoc \
	34	pve-storage-iscsidirect.adoc \
	35	pve-storage-lvm.adoc \
	36	pve-storage-nfs.adoc \
	37	pve-storage-rbd.adoc \
	38	pve-storage-zfspool.adoc \
	39	${PVE_COMMON_DOC_SOURCES}
9344ee0d	40
f6b81378 DM	41	PCT_MAN1_SOURCES= \
	42	pct.adoc \
	43	pct.1-synopsis.adoc \
	44	${PVE_COMMON_DOC_SOURCES}
	45
7f8858a2 DM	46	QM_MAN1_SOURCES= \
	47	qm.adoc \
	48	qm.1-synopsis.adoc \
	49	${PVE_COMMON_DOC_SOURCES}
	50
d7810cdb DM	51	PVEUM_MAN1_SOURCES= \
	52	pveum.adoc \
	53	pveum.1-synopsis.adoc \
	54	${PVE_COMMON_DOC_SOURCES}
	55
9344ee0d DM	56	attributes.txt docinfo.xml:
	57	cp ${DGDIR}/$@ $@.tmp
	58	mv $@.tmp $@
	59
	60	%-opts.adoc: ${DGDIR}/gen-%-opts.pl
f6b81378	61	${DGDIR}/gen-$*-opts.pl >$@.tmp
9344ee0d DM	62	mv $@.tmp $@
	63
	64	%.adoc: ${DGDIR}/gen-%-adoc.pl
f6b81378	65	${DGDIR}/gen-$*-adoc.pl >$@.tmp
9344ee0d DM	66	mv $@.tmp $@
	67
	68	%.1-synopsis.adoc:
	69	perl -I. -e "use PVE::CLI::$(subst -,_,$);print PVE::CLI::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	70	mv $@.tmp $@
	71
	72	%.8-synopsis.adoc:
	73	perl -I. -e "use PVE::Service::$(subst -,_,$);print PVE::Service::$(subst -,_,$)->generate_asciidoc_synopsys();" > $@.tmp
	74	mv $@.tmp $@
	75
f6b81378	76	ifneq (${DGDIR},.)
9344ee0d DM	77	%.adoc: ${DGDIR}/%.adoc
	78	cp $< $@.tmp
	79	mv $@.tmp $@
f6b81378	80	endif
9344ee0d DM	81
9344ee0d DM	82	pve-firewall.8: ${PVE_FIREWALL_MAN8_SOURCES}
bef0c1b4	83	a2x -a docinfo1 -a "manvolnum=8" -a "manversion=Release ${DOCRELEASE}" -f manpage pve-firewall.adoc
9344ee0d DM	84	test -n "$${NOVIEW}" \|\| man -l $@
9344ee0d DM	85
828a27f5 DM	86	pvesm.1: ${PVESM_MAN1_SOURCES}
	87	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvesm.adoc
	88	test -n "$${NOVIEW}" \|\| man -l $@
	89
f6b81378 DM	90	pct.1: ${PCT_MAN1_SOURCES}
	91	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pct.adoc
	92	test -n "$${NOVIEW}" \|\| man -l $@
	93
7f8858a2 DM	94	qm.1: ${QM_MAN1_SOURCES}
	95	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage qm.adoc
	96	test -n "$${NOVIEW}" \|\| man -l $@
	97
d8742b0c DM	98	pvecm.1: ${PVECM_MAN1_SOURCES}
	99	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pvecm.adoc
	100	test -n "$${NOVIEW}" \|\| man -l $@
	101
d7810cdb DM	102	pveum.1: ${PVEUM_MAN1_SOURCES}
	103	a2x -a docinfo1 -a "manvolnum=1" -a "manversion=Release ${DOCRELEASE}" -f manpage pveum.adoc
	104	test -n "$${NOVIEW}" \|\| man -l $@
	105
b0f56e11 DM	106	%.5: %.adoc %.5-opts.adoc ${PVE_COMMON_DOC_SOURCES}
b0f56e11 DM	107	a2x -a docinfo1 -a "manvolnum=5" -a "manversion=Release ${DOCRELEASE}" -f manpage $*.adoc
f6b81378	108	test -n "$${NOVIEW}" \|\| man -l $@
9344ee0d DM	109
	110	.PHONY: cleanup-docgen
	111	cleanup-docgen:
	112	rm -f .1 .8 *.adoc attributes.txt docinfo.xml