[ovs.git] / Documentation / automake.mk

DOC_SOURCE = \
	Documentation/group-selection-method-property.txt \
	Documentation/_static/logo.png \
	Documentation/_static/overview.png \
	Documentation/conf.py \
	Documentation/index.rst \
	Documentation/contents.rst \
	Documentation/intro/index.rst \
	Documentation/intro/what-is-ovs.rst \
	Documentation/intro/why-ovs.rst \
	Documentation/intro/install/index.rst \
	Documentation/intro/install/bash-completion.rst \
	Documentation/intro/install/debian.rst \
	Documentation/intro/install/documentation.rst \
	Documentation/intro/install/distributions.rst \
	Documentation/intro/install/dpdk.rst \
	Documentation/intro/install/fedora.rst \
	Documentation/intro/install/general.rst \
	Documentation/intro/install/netbsd.rst \
	Documentation/intro/install/ovn-upgrades.rst \
	Documentation/intro/install/rhel.rst \
	Documentation/intro/install/userspace.rst \
	Documentation/intro/install/windows.rst \
	Documentation/intro/install/xenserver.rst \
	Documentation/tutorials/index.rst \
	Documentation/tutorials/faucet.rst \
	Documentation/tutorials/ovs-advanced.rst \
	Documentation/tutorials/ovn-openstack.rst \
	Documentation/tutorials/ovn-sandbox.rst \
	Documentation/tutorials/ovs-conntrack.rst \
	Documentation/topics/index.rst \
	Documentation/topics/bonding.rst \
	Documentation/topics/idl-compound-indexes.rst \
	Documentation/topics/datapath.rst \
	Documentation/topics/design.rst \
	Documentation/topics/dpdk/index.rst \
	Documentation/topics/dpdk/bridge.rst \
	Documentation/topics/dpdk/jumbo-frames.rst \
	Documentation/topics/dpdk/memory.rst \
	Documentation/topics/dpdk/pdump.rst \
	Documentation/topics/dpdk/phy.rst \
	Documentation/topics/dpdk/pmd.rst \
	Documentation/topics/dpdk/qos.rst \
	Documentation/topics/dpdk/ring.rst \
	Documentation/topics/dpdk/vdev.rst \
	Documentation/topics/dpdk/vhost-user.rst \
	Documentation/topics/testing.rst \
	Documentation/topics/high-availability.rst \
	Documentation/topics/integration.rst \
	Documentation/topics/language-bindings.rst \
	Documentation/topics/networking-namespaces.rst \
	Documentation/topics/openflow.rst \
	Documentation/topics/ovn-news-2.8.rst \
	Documentation/topics/ovsdb-replication.rst \
	Documentation/topics/porting.rst \
	Documentation/topics/role-based-access-control.rst \
	Documentation/topics/tracing.rst \
	Documentation/topics/windows.rst \
	Documentation/howto/index.rst \
	Documentation/howto/docker.rst \
	Documentation/howto/dpdk.rst \
	Documentation/howto/firewalld.rst \
	Documentation/howto/kvm.rst \
	Documentation/howto/libvirt.rst \
	Documentation/howto/selinux.rst \
	Documentation/howto/ssl.rst \
	Documentation/howto/lisp.rst \
	Documentation/howto/openstack-containers.rst \
	Documentation/howto/qos.png \
	Documentation/howto/qos.rst \
	Documentation/howto/sflow.png \
	Documentation/howto/sflow.rst \
	Documentation/howto/tunneling.png \
	Documentation/howto/tunneling.rst \
	Documentation/howto/userspace-tunneling.rst \
	Documentation/howto/vlan.png \
	Documentation/howto/vlan.rst \
	Documentation/howto/vtep.rst \
	Documentation/ref/index.rst \
	Documentation/faq/index.rst \
	Documentation/faq/configuration.rst \
	Documentation/faq/contributing.rst \
	Documentation/faq/design.rst \
	Documentation/faq/general.rst \
	Documentation/faq/issues.rst \
	Documentation/faq/openflow.rst \
	Documentation/faq/ovn.rst \
	Documentation/faq/qos.rst \
	Documentation/faq/releases.rst \
	Documentation/faq/terminology.rst \
	Documentation/faq/vlan.rst \
	Documentation/faq/vxlan.rst \
	Documentation/internals/index.rst \
	Documentation/internals/authors.rst \
	Documentation/internals/bugs.rst \
	Documentation/internals/charter.rst \
	Documentation/internals/committer-emeritus-status.rst \
	Documentation/internals/committer-grant-revocation.rst \
	Documentation/internals/committer-responsibilities.rst \
	Documentation/internals/documentation.rst \
	Documentation/internals/mailing-lists.rst \
	Documentation/internals/maintainers.rst \
	Documentation/internals/patchwork.rst \
	Documentation/internals/release-process.rst \
	Documentation/internals/security.rst \
	Documentation/internals/contributing/index.rst \
	Documentation/internals/contributing/backporting-patches.rst \
	Documentation/internals/contributing/coding-style.rst \
	Documentation/internals/contributing/coding-style-windows.rst \
	Documentation/internals/contributing/documentation-style.rst \
	Documentation/internals/contributing/libopenvswitch-abi.rst \
	Documentation/internals/contributing/submitting-patches.rst \
	Documentation/requirements.txt \
	$(addprefix Documentation/ref/,$(RST_MANPAGES) $(RST_MANPAGES_NOINST))
FLAKE8_PYFILES += Documentation/conf.py
EXTRA_DIST += $(DOC_SOURCE)

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXSRCDIR = $(srcdir)/Documentation
SPHINXBUILDDIR = $(builddir)/Documentation/_build

# Internal variables.
ALLSPHINXOPTS = -W -n -d $(SPHINXBUILDDIR)/doctrees $(SPHINXOPTS) $(SPHINXSRCDIR)

sphinx_verbose = $(sphinx_verbose_@AM_V@)
sphinx_verbose_ = $(sphinx_verbose_@AM_DEFAULT_V@)
sphinx_verbose_0 = -q

if HAVE_SPHINX
docs-check: $(DOC_SOURCE)
	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html && touch $@
	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b man $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/man && touch $@
ALL_LOCAL += docs-check
CLEANFILES += docs-check

check-docs:
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/linkcheck

clean-docs:
	rm -rf $(SPHINXBUILDDIR)
	rm -f docs-check
CLEAN_LOCAL += clean-docs
endif
.PHONY: check-docs
.PHONY: clean-docs
\f
# Installing manpages based on rST.
#
# The docs-check target converts the rST files listed in RST_MANPAGES
# into nroff manpages in Documentation/_build/man.  The easiest way to
# get these installed by "make install" is to write our own helper
# rules.

# rST formatted manpages under Documentation/ref.
RST_MANPAGES = \
	ovs-test.8.rst \
	ovs-vlan-test.8.rst \
	ovsdb-server.7.rst \
	ovsdb.5.rst \
	ovsdb.7.rst

# rST formatted manpages that we don't want to install because they
# document stuff that only works with a build tree, not with an
# installed OVS.
RST_MANPAGES_NOINST = ovs-sim.1.rst

# The GNU standards say that these variables should control
# installation directories for manpages in each section.  Automake
# will define them for us only if it sees that a manpage in the
# appropriate section is to be installed through its built-in feature.
# Since we're working independently, for best safety, we need to
# define them ourselves.
man1dir = $(mandir)/man1
man2dir = $(mandir)/man2
man3dir = $(mandir)/man3
man4dir = $(mandir)/man4
man5dir = $(mandir)/man5
man6dir = $(mandir)/man6
man7dir = $(mandir)/man7
man8dir = $(mandir)/man8
man9dir = $(mandir)/man9

# Set a shell variable for each manpage directory.
set_mandirs = \
	man1dir='$(man1dir)' \
	man2dir='$(man2dir)' \
	man3dir='$(man3dir)' \
	man4dir='$(man4dir)' \
	man5dir='$(man5dir)' \
	man6dir='$(man6dir)' \
	man7dir='$(man7dir)' \
	man8dir='$(man8dir)' \
	man9dir='$(man9dir)'

# Given an $rst of "ovs-vlan-test.8.rst", sets $stem to
# "ovs-vlan-test", $section to "8", and $mandir to $man8dir.
extract_stem_and_section = \
	stem=`echo "$$rst" | sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\1/p'`; \
	section=`echo "$$rst" | sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\2/p'`; \
	test -n "$$section" || { echo "$$rst: cannot infer manpage section from filename" 2>&1; continue; }; \
	eval "mandir=\$$man$${section}dir"; \
	test -n "$$mandir" || { echo "unknown directory for manpage section $$section"; continue; }

INSTALL_DATA_LOCAL += install-man-rst
if HAVE_SPHINX
install-man-rst: docs-check
	@$(set_mandirs); \
	for rst in $(RST_MANPAGES) $(EXTRA_RST_MANPAGES); do \
	    $(extract_stem_and_section); \
	    echo " $(MKDIR_P) '$(DESTDIR)'\"$$mandir\""; \
	    $(MKDIR_P) '$(DESTDIR)'"$$mandir"; \
	    echo " $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
	    $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
	done
else
install-man-rst:
	@:
endif

UNINSTALL_LOCAL += uninstall-man-rst
uninstall-man-rst:
	@$(set_mandirs); \
	for rst in $(RST_MANPAGES); do \
	    $(extract_stem_and_section); \
	    echo "rm -f '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
	    rm -f '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
	done
Commit	Line	Data
e9f521b3	1	DOC_SOURCE = \
c431227e	2	Documentation/group-selection-method-property.txt \
daf5079e	3	Documentation/_static/logo.png \
2eaf6a08	4	Documentation/_static/overview.png \
daf5079e SF	5	Documentation/conf.py \
daf5079e SF	6	Documentation/index.rst \
11820a1f SF	7	Documentation/contents.rst \
11820a1f SF	8	Documentation/intro/index.rst \
2eaf6a08	9	Documentation/intro/what-is-ovs.rst \
3c8a3b31	10	Documentation/intro/why-ovs.rst \
11820a1f	11	Documentation/intro/install/index.rst \
795752a3 SF	12	Documentation/intro/install/bash-completion.rst \
795752a3 SF	13	Documentation/intro/install/debian.rst \
73c76b44	14	Documentation/intro/install/documentation.rst \
4ae3db4a	15	Documentation/intro/install/distributions.rst \
795752a3 SF	16	Documentation/intro/install/dpdk.rst \
	17	Documentation/intro/install/fedora.rst \
	18	Documentation/intro/install/general.rst \
	19	Documentation/intro/install/netbsd.rst \
ab979fd2	20	Documentation/intro/install/ovn-upgrades.rst \
795752a3 SF	21	Documentation/intro/install/rhel.rst \
	22	Documentation/intro/install/userspace.rst \
	23	Documentation/intro/install/windows.rst \
	24	Documentation/intro/install/xenserver.rst \
11820a1f	25	Documentation/tutorials/index.rst \
98dc8dee	26	Documentation/tutorials/faucet.rst \
e12569bb	27	Documentation/tutorials/ovs-advanced.rst \
a16189ae	28	Documentation/tutorials/ovn-openstack.rst \
46a2dc58	29	Documentation/tutorials/ovn-sandbox.rst \
c9ccdec7	30	Documentation/tutorials/ovs-conntrack.rst \
11820a1f	31	Documentation/topics/index.rst \
7c9afefd	32	Documentation/topics/bonding.rst \
e90bc056	33	Documentation/topics/idl-compound-indexes.rst \
7c9afefd SF	34	Documentation/topics/datapath.rst \
7c9afefd SF	35	Documentation/topics/design.rst \
e69e4f5b	36	Documentation/topics/dpdk/index.rst \
7b743caf	37	Documentation/topics/dpdk/bridge.rst \
a790e75f	38	Documentation/topics/dpdk/jumbo-frames.rst \
43307ad0	39	Documentation/topics/dpdk/memory.rst \
099a3547	40	Documentation/topics/dpdk/pdump.rst \
6477dbb9	41	Documentation/topics/dpdk/phy.rst \
31d0dae2	42	Documentation/topics/dpdk/pmd.rst \
6fe32f11	43	Documentation/topics/dpdk/qos.rst \
144d1cee	44	Documentation/topics/dpdk/ring.rst \
b20eabc3	45	Documentation/topics/dpdk/vdev.rst \
e69e4f5b	46	Documentation/topics/dpdk/vhost-user.rst \
e69e4f5b	47	Documentation/topics/testing.rst \
7c9afefd SF	48	Documentation/topics/high-availability.rst \
7c9afefd SF	49	Documentation/topics/integration.rst \
f150a8ba	50	Documentation/topics/language-bindings.rst \
60405863	51	Documentation/topics/networking-namespaces.rst \
7c9afefd	52	Documentation/topics/openflow.rst \
9e848936	53	Documentation/topics/ovn-news-2.8.rst \
7c9afefd SF	54	Documentation/topics/ovsdb-replication.rst \
7c9afefd SF	55	Documentation/topics/porting.rst \
431e90b7	56	Documentation/topics/role-based-access-control.rst \
73f5354b	57	Documentation/topics/tracing.rst \
7c9afefd	58	Documentation/topics/windows.rst \
11820a1f	59	Documentation/howto/index.rst \
795752a3	60	Documentation/howto/docker.rst \
e69e4f5b	61	Documentation/howto/dpdk.rst \
2c71d7d8	62	Documentation/howto/firewalld.rst \
795752a3 SF	63	Documentation/howto/kvm.rst \
	64	Documentation/howto/libvirt.rst \
	65	Documentation/howto/selinux.rst \
	66	Documentation/howto/ssl.rst \
43f317ff SF	67	Documentation/howto/lisp.rst \
43f317ff SF	68	Documentation/howto/openstack-containers.rst \
b0bef8d1 SF	69	Documentation/howto/qos.png \
b0bef8d1 SF	70	Documentation/howto/qos.rst \
198c5d3d SF	71	Documentation/howto/sflow.png \
198c5d3d SF	72	Documentation/howto/sflow.rst \
4643d687 SF	73	Documentation/howto/tunneling.png \
4643d687 SF	74	Documentation/howto/tunneling.rst \
b438493e	75	Documentation/howto/userspace-tunneling.rst \
e37319ea SF	76	Documentation/howto/vlan.png \
e37319ea SF	77	Documentation/howto/vlan.rst \
43f317ff	78	Documentation/howto/vtep.rst \
11820a1f SF	79	Documentation/ref/index.rst \
11820a1f SF	80	Documentation/faq/index.rst \
11e02906 SF	81	Documentation/faq/configuration.rst \
	82	Documentation/faq/contributing.rst \
	83	Documentation/faq/design.rst \
	84	Documentation/faq/general.rst \
	85	Documentation/faq/issues.rst \
	86	Documentation/faq/openflow.rst \
81ebfc5c	87	Documentation/faq/ovn.rst \
11e02906 SF	88	Documentation/faq/qos.rst \
	89	Documentation/faq/releases.rst \
	90	Documentation/faq/terminology.rst \
	91	Documentation/faq/vlan.rst \
	92	Documentation/faq/vxlan.rst \
d0e53b15 SF	93	Documentation/internals/index.rst \
	94	Documentation/internals/authors.rst \
	95	Documentation/internals/bugs.rst \
45c2f69a	96	Documentation/internals/charter.rst \
43e9c263	97	Documentation/internals/committer-emeritus-status.rst \
d0e53b15 SF	98	Documentation/internals/committer-grant-revocation.rst \
d0e53b15 SF	99	Documentation/internals/committer-responsibilities.rst \
1e6567d4	100	Documentation/internals/documentation.rst \
d0e53b15 SF	101	Documentation/internals/mailing-lists.rst \
d0e53b15 SF	102	Documentation/internals/maintainers.rst \
3c2604f7	103	Documentation/internals/patchwork.rst \
d0e53b15 SF	104	Documentation/internals/release-process.rst \
	105	Documentation/internals/security.rst \
	106	Documentation/internals/contributing/index.rst \
1102cc39	107	Documentation/internals/contributing/backporting-patches.rst \
d0e53b15 SF	108	Documentation/internals/contributing/coding-style.rst \
	109	Documentation/internals/contributing/coding-style-windows.rst \
	110	Documentation/internals/contributing/documentation-style.rst \
cb991590	111	Documentation/internals/contributing/libopenvswitch-abi.rst \
73c76b44	112	Documentation/internals/contributing/submitting-patches.rst \
fd0837a7	113	Documentation/requirements.txt \
16ee8726	114	$(addprefix Documentation/ref/,$(RST_MANPAGES) $(RST_MANPAGES_NOINST))
b9b3b9ce	115	FLAKE8_PYFILES += Documentation/conf.py
e9f521b3 RB	116	EXTRA_DIST += $(DOC_SOURCE)
e9f521b3 RB	117
daf5079e SF	118	# You can set these variables from the command line.
	119	SPHINXOPTS =
	120	SPHINXBUILD = sphinx-build
	121	SPHINXSRCDIR = $(srcdir)/Documentation
c431227e	122	SPHINXBUILDDIR = $(builddir)/Documentation/_build
daf5079e SF	123
daf5079e SF	124	# Internal variables.
70cb24de	125	ALLSPHINXOPTS = -W -n -d $(SPHINXBUILDDIR)/doctrees $(SPHINXOPTS) $(SPHINXSRCDIR)
daf5079e	126
099cf485 SF	127	sphinx_verbose = $(sphinx_verbose_@AM_V@)
	128	sphinx_verbose_ = $(sphinx_verbose_@AM_DEFAULT_V@)
	129	sphinx_verbose_0 = -q
d84bdc82 SF	130
d84bdc82 SF	131	if HAVE_SPHINX
fd0837a7	132	docs-check: $(DOC_SOURCE)
e9f521b3	133	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html && touch $@
fd0837a7 SF	134	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b man $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/man && touch $@
	135	ALL_LOCAL += docs-check
	136	CLEANFILES += docs-check
099cf485 SF	137
	138	check-docs:
	139	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/linkcheck
f93f0e4a SF	140
f93f0e4a SF	141	clean-docs:
fd0837a7	142	rm -rf $(SPHINXBUILDDIR)
f654d6e4	143	rm -f docs-check
f93f0e4a	144	CLEAN_LOCAL += clean-docs
d84bdc82	145	endif
d84bdc82	146	.PHONY: check-docs
f93f0e4a	147	.PHONY: clean-docs
fd0837a7 SF	148	\f
	149	# Installing manpages based on rST.
	150	#
	151	# The docs-check target converts the rST files listed in RST_MANPAGES
	152	# into nroff manpages in Documentation/_build/man. The easiest way to
	153	# get these installed by "make install" is to write our own helper
	154	# rules.
	155
	156	# rST formatted manpages under Documentation/ref.
	157	RST_MANPAGES = \
3591d8c7	158	ovs-test.8.rst \
12b84d50 BP	159	ovs-vlan-test.8.rst \
	160	ovsdb-server.7.rst \
	161	ovsdb.5.rst \
16ee8726 BP	162	ovsdb.7.rst
	163
	164	# rST formatted manpages that we don't want to install because they
	165	# document stuff that only works with a build tree, not with an
	166	# installed OVS.
	167	RST_MANPAGES_NOINST = ovs-sim.1.rst
fd0837a7 SF	168
	169	# The GNU standards say that these variables should control
	170	# installation directories for manpages in each section. Automake
	171	# will define them for us only if it sees that a manpage in the
	172	# appropriate section is to be installed through its built-in feature.
	173	# Since we're working independently, for best safety, we need to
	174	# define them ourselves.
	175	man1dir = $(mandir)/man1
	176	man2dir = $(mandir)/man2
	177	man3dir = $(mandir)/man3
	178	man4dir = $(mandir)/man4
	179	man5dir = $(mandir)/man5
	180	man6dir = $(mandir)/man6
	181	man7dir = $(mandir)/man7
	182	man8dir = $(mandir)/man8
	183	man9dir = $(mandir)/man9
	184
	185	# Set a shell variable for each manpage directory.
	186	set_mandirs = \
	187	man1dir='$(man1dir)' \
	188	man2dir='$(man2dir)' \
	189	man3dir='$(man3dir)' \
	190	man4dir='$(man4dir)' \
	191	man5dir='$(man5dir)' \
	192	man6dir='$(man6dir)' \
	193	man7dir='$(man7dir)' \
	194	man8dir='$(man8dir)' \
	195	man9dir='$(man9dir)'
	196
	197	# Given an $rst of "ovs-vlan-test.8.rst", sets $stem to
	198	# "ovs-vlan-test", $section to "8", and $mandir to $man8dir.
	199	extract_stem_and_section = \
	200	stem=`echo "$$rst" \| sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\1/p'`; \
	201	section=`echo "$$rst" \| sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\2/p'`; \
	202	test -n "$$section" \|\| { echo "$$rst: cannot infer manpage section from filename" 2>&1; continue; }; \
	203	eval "mandir=\$$man$${section}dir"; \
	204	test -n "$$mandir" \|\| { echo "unknown directory for manpage section $$section"; continue; }
	205
fd0837a7	206	INSTALL_DATA_LOCAL += install-man-rst
9db5e1ef	207	if HAVE_SPHINX
fd0837a7 SF	208	install-man-rst: docs-check
fd0837a7 SF	209	@$(set_mandirs); \
16ee8726	210	for rst in $(RST_MANPAGES) $(EXTRA_RST_MANPAGES); do \
fd0837a7 SF	211	$(extract_stem_and_section); \
	212	echo " $(MKDIR_P) '$(DESTDIR)'\"$$mandir\""; \
	213	$(MKDIR_P) '$(DESTDIR)'"$$mandir"; \
	214	echo " $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
	215	$(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
	216	done
9db5e1ef BP	217	else
	218	install-man-rst:
	219	@:
fd0837a7 SF	220	endif
	221
	222	UNINSTALL_LOCAL += uninstall-man-rst
	223	uninstall-man-rst:
	224	@$(set_mandirs); \
	225	for rst in $(RST_MANPAGES); do \
	226	$(extract_stem_and_section); \
	227	echo "rm -f '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
	228	rm -f '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
	229	done