[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/ovs-advanced.rst \
	Documentation/tutorials/ovn-openstack.rst \
	Documentation/tutorials/ovn-sandbox.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/ring.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/openflow.rst \
	Documentation/topics/ovsdb-replication.rst \
	Documentation/topics/porting.rst \
	Documentation/topics/tracing.rst \
	Documentation/topics/windows.rst \
	Documentation/howto/index.rst \
	Documentation/howto/docker.rst \
	Documentation/howto/dpdk.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/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/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))
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

# 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; }

if HAVE_SPHINX
INSTALL_DATA_LOCAL += install-man-rst
install-man-rst: docs-check
	@$(set_mandirs); \
	for rst in $(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
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 \
e12569bb	26	Documentation/tutorials/ovs-advanced.rst \
a16189ae	27	Documentation/tutorials/ovn-openstack.rst \
46a2dc58	28	Documentation/tutorials/ovn-sandbox.rst \
11820a1f	29	Documentation/topics/index.rst \
7c9afefd	30	Documentation/topics/bonding.rst \
e90bc056	31	Documentation/topics/idl-compound-indexes.rst \
7c9afefd SF	32	Documentation/topics/datapath.rst \
7c9afefd SF	33	Documentation/topics/design.rst \
e69e4f5b	34	Documentation/topics/dpdk/index.rst \
144d1cee	35	Documentation/topics/dpdk/ring.rst \
e69e4f5b	36	Documentation/topics/dpdk/vhost-user.rst \
e69e4f5b	37	Documentation/topics/testing.rst \
7c9afefd SF	38	Documentation/topics/high-availability.rst \
7c9afefd SF	39	Documentation/topics/integration.rst \
f150a8ba	40	Documentation/topics/language-bindings.rst \
7c9afefd SF	41	Documentation/topics/openflow.rst \
	42	Documentation/topics/ovsdb-replication.rst \
	43	Documentation/topics/porting.rst \
73f5354b	44	Documentation/topics/tracing.rst \
7c9afefd	45	Documentation/topics/windows.rst \
11820a1f	46	Documentation/howto/index.rst \
795752a3	47	Documentation/howto/docker.rst \
e69e4f5b	48	Documentation/howto/dpdk.rst \
795752a3 SF	49	Documentation/howto/kvm.rst \
	50	Documentation/howto/libvirt.rst \
	51	Documentation/howto/selinux.rst \
	52	Documentation/howto/ssl.rst \
43f317ff SF	53	Documentation/howto/lisp.rst \
43f317ff SF	54	Documentation/howto/openstack-containers.rst \
b0bef8d1 SF	55	Documentation/howto/qos.png \
b0bef8d1 SF	56	Documentation/howto/qos.rst \
198c5d3d SF	57	Documentation/howto/sflow.png \
198c5d3d SF	58	Documentation/howto/sflow.rst \
4643d687 SF	59	Documentation/howto/tunneling.png \
4643d687 SF	60	Documentation/howto/tunneling.rst \
b438493e	61	Documentation/howto/userspace-tunneling.rst \
e37319ea SF	62	Documentation/howto/vlan.png \
e37319ea SF	63	Documentation/howto/vlan.rst \
43f317ff	64	Documentation/howto/vtep.rst \
11820a1f SF	65	Documentation/ref/index.rst \
11820a1f SF	66	Documentation/faq/index.rst \
11e02906 SF	67	Documentation/faq/configuration.rst \
	68	Documentation/faq/contributing.rst \
	69	Documentation/faq/design.rst \
	70	Documentation/faq/general.rst \
	71	Documentation/faq/issues.rst \
	72	Documentation/faq/openflow.rst \
	73	Documentation/faq/qos.rst \
	74	Documentation/faq/releases.rst \
	75	Documentation/faq/terminology.rst \
	76	Documentation/faq/vlan.rst \
	77	Documentation/faq/vxlan.rst \
d0e53b15 SF	78	Documentation/internals/index.rst \
	79	Documentation/internals/authors.rst \
	80	Documentation/internals/bugs.rst \
	81	Documentation/internals/committer-grant-revocation.rst \
	82	Documentation/internals/committer-responsibilities.rst \
1e6567d4	83	Documentation/internals/documentation.rst \
d0e53b15 SF	84	Documentation/internals/mailing-lists.rst \
d0e53b15 SF	85	Documentation/internals/maintainers.rst \
3c2604f7	86	Documentation/internals/patchwork.rst \
d0e53b15 SF	87	Documentation/internals/release-process.rst \
	88	Documentation/internals/security.rst \
	89	Documentation/internals/contributing/index.rst \
1102cc39	90	Documentation/internals/contributing/backporting-patches.rst \
d0e53b15 SF	91	Documentation/internals/contributing/coding-style.rst \
	92	Documentation/internals/contributing/coding-style-windows.rst \
	93	Documentation/internals/contributing/documentation-style.rst \
cb991590	94	Documentation/internals/contributing/libopenvswitch-abi.rst \
73c76b44	95	Documentation/internals/contributing/submitting-patches.rst \
fd0837a7 SF	96	Documentation/requirements.txt \
fd0837a7 SF	97	$(addprefix Documentation/ref/,$(RST_MANPAGES))
b9b3b9ce	98	FLAKE8_PYFILES += Documentation/conf.py
e9f521b3 RB	99	EXTRA_DIST += $(DOC_SOURCE)
e9f521b3 RB	100
daf5079e SF	101	# You can set these variables from the command line.
	102	SPHINXOPTS =
	103	SPHINXBUILD = sphinx-build
	104	SPHINXSRCDIR = $(srcdir)/Documentation
c431227e	105	SPHINXBUILDDIR = $(builddir)/Documentation/_build
daf5079e SF	106
daf5079e SF	107	# Internal variables.
70cb24de	108	ALLSPHINXOPTS = -W -n -d $(SPHINXBUILDDIR)/doctrees $(SPHINXOPTS) $(SPHINXSRCDIR)
daf5079e	109
099cf485 SF	110	sphinx_verbose = $(sphinx_verbose_@AM_V@)
	111	sphinx_verbose_ = $(sphinx_verbose_@AM_DEFAULT_V@)
	112	sphinx_verbose_0 = -q
d84bdc82 SF	113
d84bdc82 SF	114	if HAVE_SPHINX
fd0837a7	115	docs-check: $(DOC_SOURCE)
e9f521b3	116	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b html $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/html && touch $@
fd0837a7 SF	117	$(AM_V_GEN)$(SPHINXBUILD) $(sphinx_verbose) -b man $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/man && touch $@
	118	ALL_LOCAL += docs-check
	119	CLEANFILES += docs-check
099cf485 SF	120
	121	check-docs:
	122	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/linkcheck
f93f0e4a SF	123
f93f0e4a SF	124	clean-docs:
fd0837a7	125	rm -rf $(SPHINXBUILDDIR)
f654d6e4	126	rm -f docs-check
f93f0e4a	127	CLEAN_LOCAL += clean-docs
d84bdc82	128	endif
d84bdc82	129	.PHONY: check-docs
f93f0e4a	130	.PHONY: clean-docs
fd0837a7 SF	131	\f
	132	# Installing manpages based on rST.
	133	#
	134	# The docs-check target converts the rST files listed in RST_MANPAGES
	135	# into nroff manpages in Documentation/_build/man. The easiest way to
	136	# get these installed by "make install" is to write our own helper
	137	# rules.
	138
	139	# rST formatted manpages under Documentation/ref.
	140	RST_MANPAGES = \
3591d8c7	141	ovs-test.8.rst \
fd0837a7 SF	142	ovs-vlan-test.8.rst
	143
	144	# The GNU standards say that these variables should control
	145	# installation directories for manpages in each section. Automake
	146	# will define them for us only if it sees that a manpage in the
	147	# appropriate section is to be installed through its built-in feature.
	148	# Since we're working independently, for best safety, we need to
	149	# define them ourselves.
	150	man1dir = $(mandir)/man1
	151	man2dir = $(mandir)/man2
	152	man3dir = $(mandir)/man3
	153	man4dir = $(mandir)/man4
	154	man5dir = $(mandir)/man5
	155	man6dir = $(mandir)/man6
	156	man7dir = $(mandir)/man7
	157	man8dir = $(mandir)/man8
	158	man9dir = $(mandir)/man9
	159
	160	# Set a shell variable for each manpage directory.
	161	set_mandirs = \
	162	man1dir='$(man1dir)' \
	163	man2dir='$(man2dir)' \
	164	man3dir='$(man3dir)' \
	165	man4dir='$(man4dir)' \
	166	man5dir='$(man5dir)' \
	167	man6dir='$(man6dir)' \
	168	man7dir='$(man7dir)' \
	169	man8dir='$(man8dir)' \
	170	man9dir='$(man9dir)'
	171
	172	# Given an $rst of "ovs-vlan-test.8.rst", sets $stem to
	173	# "ovs-vlan-test", $section to "8", and $mandir to $man8dir.
	174	extract_stem_and_section = \
	175	stem=`echo "$$rst" \| sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\1/p'`; \
	176	section=`echo "$$rst" \| sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\2/p'`; \
	177	test -n "$$section" \|\| { echo "$$rst: cannot infer manpage section from filename" 2>&1; continue; }; \
	178	eval "mandir=\$$man$${section}dir"; \
	179	test -n "$$mandir" \|\| { echo "unknown directory for manpage section $$section"; continue; }
	180
	181	if HAVE_SPHINX
	182	INSTALL_DATA_LOCAL += install-man-rst
	183	install-man-rst: docs-check
	184	@$(set_mandirs); \
	185	for rst in $(RST_MANPAGES); do \
	186	$(extract_stem_and_section); \
	187	echo " $(MKDIR_P) '$(DESTDIR)'\"$$mandir\""; \
	188	$(MKDIR_P) '$(DESTDIR)'"$$mandir"; \
	189	echo " $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
	190	$(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
	191	done
	192	endif
	193
	194	UNINSTALL_LOCAL += uninstall-man-rst
	195	uninstall-man-rst:
	196	@$(set_mandirs); \
	197	for rst in $(RST_MANPAGES); do \
	198	$(extract_stem_and_section); \
	199	echo "rm -f '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
	200	rm -f '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
	201	done