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/afxdp.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/rhel.rst \

Documentation/intro/install/userspace.rst \

Documentation/intro/install/windows.rst \

Documentation/tutorials/index.rst \

Documentation/tutorials/faucet.rst \

Documentation/tutorials/ovs-advanced.rst \

Documentation/tutorials/ovs-conntrack.rst \

Documentation/tutorials/ipsec.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/phy.rst \

Documentation/topics/dpdk/pmd.rst \

Documentation/topics/dpdk/qos.rst \

Documentation/topics/dpdk/vdev.rst \

Documentation/topics/dpdk/vhost-user.rst \

Documentation/topics/fuzzing/index.rst \

Documentation/topics/fuzzing/what-is-fuzzing.rst \

Documentation/topics/fuzzing/ovs-fuzzing-infrastructure.rst \

Documentation/topics/fuzzing/ovs-fuzzers.rst \

Documentation/topics/fuzzing/security-analysis-of-ovs-fuzzers.rst \

Documentation/topics/testing.rst \

Documentation/topics/integration.rst \

Documentation/topics/language-bindings.rst \

Documentation/topics/networking-namespaces.rst \

Documentation/topics/openflow.rst \

Documentation/topics/ovs-extensions.rst \

Documentation/topics/ovsdb-relay.rst \

Documentation/topics/ovsdb-replication.rst \

Documentation/topics/porting.rst \

Documentation/topics/record-replay.rst \

Documentation/topics/tracing.rst \

Documentation/topics/usdt-probes.rst \

Documentation/topics/userspace-checksum-offloading.rst \

Documentation/topics/userspace-tso.rst \

Documentation/topics/userspace-tx-steering.rst \

Documentation/topics/windows.rst \

Documentation/howto/index.rst \

Documentation/howto/dpdk.rst \

Documentation/howto/ipsec.rst \

Documentation/howto/kvm.rst \

Documentation/howto/libvirt.rst \

Documentation/howto/selinux.rst \

Documentation/howto/ssl.rst \

Documentation/howto/lisp.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/howto/tc-offload.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/faq/bareudp.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/inclusive-language.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)

SPHINXOPTS =

SPHINXSRCDIR = $(srcdir)/Documentation

SPHINXBUILDDIR = $(builddir)/Documentation/_build

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



RST_MANPAGES = \

ovs-actions.7.rst \

ovs-appctl.8.rst \

ovs-ctl.8.rst \

ovs-l3ping.8.rst \

ovs-parse-backtrace.8.rst \

ovs-pki.8.rst \

ovs-tcpdump.8.rst \

ovs-tcpundump.1.rst \

ovs-test.8.rst \

ovs-vlan-test.8.rst \

ovsdb-server.7.rst \

ovsdb.5.rst \

ovsdb.7.rst

RST_MANPAGES_NOINST = ovs-sim.1.rst

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_mandirs = \

man1dir='$(man1dir)' \

man2dir='$(man2dir)' \

man3dir='$(man3dir)' \

man4dir='$(man4dir)' \

man5dir='$(man5dir)' \

man6dir='$(man6dir)' \

man7dir='$(man7dir)' \

man8dir='$(man8dir)' \

man9dir='$(man9dir)'

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"; \

if test -f $(SPHINXBUILDDIR)/man/$$stem.$$section; then \

filepath=$(SPHINXBUILDDIR)/man/$$stem.$$section; \

else \

filepath=$(SPHINXBUILDDIR)/man/$$section/$$stem.$$section; \

fi; \

echo " $(INSTALL_DATA) $$filepath '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \

$(INSTALL_DATA) $$filepath '$(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