2 Documentation
/group-selection-method-property.txt \
3 Documentation
/_static
/logo.png \
4 Documentation
/_static
/overview.png \
5 Documentation
/conf.py \
6 Documentation
/index.rst \
7 Documentation
/contents.rst \
8 Documentation
/intro
/index.rst \
9 Documentation
/intro
/what-is-ovs.rst \
10 Documentation
/intro
/why-ovs.rst \
11 Documentation
/intro
/install/index.rst \
12 Documentation
/intro
/install/bash-completion.rst \
13 Documentation
/intro
/install/debian.rst \
14 Documentation
/intro
/install/documentation.rst \
15 Documentation
/intro
/install/distributions.rst \
16 Documentation
/intro
/install/dpdk.rst \
17 Documentation
/intro
/install/fedora.rst \
18 Documentation
/intro
/install/general.rst \
19 Documentation
/intro
/install/netbsd.rst \
20 Documentation
/intro
/install/ovn-upgrades.rst \
21 Documentation
/intro
/install/rhel.rst \
22 Documentation
/intro
/install/userspace.rst \
23 Documentation
/intro
/install/windows.rst \
24 Documentation
/intro
/install/xenserver.rst \
25 Documentation
/tutorials
/index.rst \
26 Documentation
/tutorials
/faucet.rst \
27 Documentation
/tutorials
/ovs-advanced.rst \
28 Documentation
/tutorials
/ovn-openstack.rst \
29 Documentation
/tutorials
/ovn-sandbox.rst \
30 Documentation
/topics
/index.rst \
31 Documentation
/topics
/bonding.rst \
32 Documentation
/topics
/idl-compound-indexes.rst \
33 Documentation
/topics
/datapath.rst \
34 Documentation
/topics
/design.rst \
35 Documentation
/topics
/dpdk
/index.rst \
36 Documentation
/topics
/dpdk
/ring.rst \
37 Documentation
/topics
/dpdk
/vhost-user.rst \
38 Documentation
/topics
/testing.rst \
39 Documentation
/topics
/high-availability.rst \
40 Documentation
/topics
/integration.rst \
41 Documentation
/topics
/language-bindings.rst \
42 Documentation
/topics
/openflow.rst \
43 Documentation
/topics
/ovsdb-replication.rst \
44 Documentation
/topics
/porting.rst \
45 Documentation
/topics
/role-based-access-control.rst \
46 Documentation
/topics
/tracing.rst \
47 Documentation
/topics
/windows.rst \
48 Documentation
/howto
/index.rst \
49 Documentation
/howto
/docker.rst \
50 Documentation
/howto
/dpdk.rst \
51 Documentation
/howto
/firewalld.rst \
52 Documentation
/howto
/kvm.rst \
53 Documentation
/howto
/libvirt.rst \
54 Documentation
/howto
/selinux.rst \
55 Documentation
/howto
/ssl.rst \
56 Documentation
/howto
/lisp.rst \
57 Documentation
/howto
/openstack-containers.rst \
58 Documentation
/howto
/qos.png \
59 Documentation
/howto
/qos.rst \
60 Documentation
/howto
/sflow.png \
61 Documentation
/howto
/sflow.rst \
62 Documentation
/howto
/tunneling.png \
63 Documentation
/howto
/tunneling.rst \
64 Documentation
/howto
/userspace-tunneling.rst \
65 Documentation
/howto
/vlan.png \
66 Documentation
/howto
/vlan.rst \
67 Documentation
/howto
/vtep.rst \
68 Documentation
/ref
/index.rst \
69 Documentation
/faq
/index.rst \
70 Documentation
/faq
/configuration.rst \
71 Documentation
/faq
/contributing.rst \
72 Documentation
/faq
/design.rst \
73 Documentation
/faq
/general.rst \
74 Documentation
/faq
/issues.rst \
75 Documentation
/faq
/openflow.rst \
76 Documentation
/faq
/qos.rst \
77 Documentation
/faq
/releases.rst \
78 Documentation
/faq
/terminology.rst \
79 Documentation
/faq
/vlan.rst \
80 Documentation
/faq
/vxlan.rst \
81 Documentation
/internals
/index.rst \
82 Documentation
/internals
/authors.rst \
83 Documentation
/internals
/bugs.rst \
84 Documentation
/internals
/charter.rst \
85 Documentation
/internals
/committer-emeritus-status.rst \
86 Documentation
/internals
/committer-grant-revocation.rst \
87 Documentation
/internals
/committer-responsibilities.rst \
88 Documentation
/internals
/documentation.rst \
89 Documentation
/internals
/mailing-lists.rst \
90 Documentation
/internals
/maintainers.rst \
91 Documentation
/internals
/patchwork.rst \
92 Documentation
/internals
/release-process.rst \
93 Documentation
/internals
/security.rst \
94 Documentation
/internals
/contributing
/index.rst \
95 Documentation
/internals
/contributing
/backporting-patches.rst \
96 Documentation
/internals
/contributing
/coding-style.rst \
97 Documentation
/internals
/contributing
/coding-style-windows.rst \
98 Documentation
/internals
/contributing
/documentation-style.rst \
99 Documentation
/internals
/contributing
/libopenvswitch-abi.rst \
100 Documentation
/internals
/contributing
/submitting-patches.rst \
101 Documentation
/requirements.txt \
102 $(addprefix Documentation
/ref
/,$(RST_MANPAGES
))
103 FLAKE8_PYFILES
+= Documentation
/conf.py
104 EXTRA_DIST
+= $(DOC_SOURCE
)
106 # You can set these variables from the command line.
108 SPHINXBUILD
= sphinx-build
109 SPHINXSRCDIR
= $(srcdir)/Documentation
110 SPHINXBUILDDIR
= $(builddir
)/Documentation
/_build
112 # Internal variables.
113 ALLSPHINXOPTS
= -W
-n
-d
$(SPHINXBUILDDIR
)/doctrees
$(SPHINXOPTS
) $(SPHINXSRCDIR
)
115 sphinx_verbose
= $(sphinx_verbose_@AM_V@
)
116 sphinx_verbose_
= $(sphinx_verbose_@AM_DEFAULT_V@
)
117 sphinx_verbose_0
= -q
120 docs-check
: $(DOC_SOURCE
)
121 $(AM_V_GEN
)$(SPHINXBUILD
) $(sphinx_verbose
) -b html
$(ALLSPHINXOPTS
) $(SPHINXBUILDDIR
)/html
&& touch
$@
122 $(AM_V_GEN
)$(SPHINXBUILD
) $(sphinx_verbose
) -b man
$(ALLSPHINXOPTS
) $(SPHINXBUILDDIR
)/man
&& touch
$@
123 ALL_LOCAL
+= docs-check
124 CLEANFILES
+= docs-check
127 $(SPHINXBUILD
) -b linkcheck
$(ALLSPHINXOPTS
) $(SPHINXBUILDDIR
)/linkcheck
130 rm -rf
$(SPHINXBUILDDIR
)
132 CLEAN_LOCAL
+= clean-docs
137 # Installing manpages based on rST.
139 # The docs-check target converts the rST files listed in RST_MANPAGES
140 # into nroff manpages in Documentation/_build/man. The easiest way to
141 # get these installed by "make install" is to write our own helper
144 # rST formatted manpages under Documentation/ref.
149 # The GNU standards say that these variables should control
150 # installation directories for manpages in each section. Automake
151 # will define them for us only if it sees that a manpage in the
152 # appropriate section is to be installed through its built-in feature.
153 # Since we're working independently, for best safety, we need to
154 # define them ourselves.
155 man1dir = $(mandir)/man1
156 man2dir = $(mandir)/man2
157 man3dir = $(mandir)/man3
158 man4dir = $(mandir)/man4
159 man5dir = $(mandir)/man5
160 man6dir = $(mandir)/man6
161 man7dir = $(mandir)/man7
162 man8dir = $(mandir)/man8
163 man9dir = $(mandir)/man9
165 # Set a shell variable for each manpage directory.
167 man1dir='$(man1dir)' \
168 man2dir='$(man2dir)' \
169 man3dir='$(man3dir)' \
170 man4dir='$(man4dir)' \
171 man5dir='$(man5dir)' \
172 man6dir='$(man6dir)' \
173 man7dir='$(man7dir)' \
174 man8dir='$(man8dir)' \
177 # Given an $rst of "ovs-vlan-test.8.rst", sets $stem to
178 # "ovs-vlan-test", $section to "8", and $mandir to $man8dir.
179 extract_stem_and_section
= \
180 stem
=`echo "$$rst" | sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\1/p'`; \
181 section
=`echo "$$rst" | sed -n 's/^\(.*\)\.\([0-9]\).rst$$/\2/p'`; \
182 test -n
"$$section" ||
{ echo
"$$rst: cannot infer manpage section from filename" 2>&1; continue
; }; \
183 eval
"mandir=\$$man$${section}dir"; \
184 test -n
"$$mandir" ||
{ echo
"unknown directory for manpage section $$section"; continue
; }
186 INSTALL_DATA_LOCAL
+= install-man-rst
188 install-man-rst
: docs-check
190 for rst in
$(RST_MANPAGES
); do \
191 $(extract_stem_and_section
); \
192 echo
" $(MKDIR_P) '$(DESTDIR)'\"$$mandir\""; \
193 $(MKDIR_P
) '$(DESTDIR)'"$$mandir"; \
194 echo
" $(INSTALL_DATA) $(SPHINXBUILDDIR)/man/$$stem.$$section '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
195 $(INSTALL_DATA
) $(SPHINXBUILDDIR
)/man
/$$stem.
$$section '$(DESTDIR)'"$$mandir/$$stem.$$section"; \
202 UNINSTALL_LOCAL
+= uninstall-man-rst
205 for rst in
$(RST_MANPAGES
); do \
206 $(extract_stem_and_section
); \
207 echo
"rm -f '$(DESTDIR)'\"$$mandir/$$stem.$$section\""; \
208 rm -f
'$(DESTDIR)'"$$mandir/$$stem.$$section"; \