documentation: Document ovs-flowviz.

Add a man page for ovs-flowviz as well as a topic page with some more detailed examples. Signed-off-by: Adrian Moreno <amorenoz@redhat.com> Signed-off-by: 0-day Robot <robot@bytheb.org>
ovsrobot · Sep 25, 2024 · 776a436 · 776a436
1 parent cf37a5c
commit 776a436
Show file tree

Hide file tree

Showing 9 changed files with 867 additions and 2 deletions.
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
@@ -45,7 +45,7 @@ DOC_SOURCE = \
 	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/flow-visualization.rst \
 	Documentation/topics/integration.rst \
 	Documentation/topics/language-bindings.rst \
 	Documentation/topics/networking-namespaces.rst \
@@ -55,6 +55,7 @@ DOC_SOURCE = \
 	Documentation/topics/ovsdb-replication.rst \
 	Documentation/topics/porting.rst \
 	Documentation/topics/record-replay.rst \
+	Documentation/topics/testing.rst \
 	Documentation/topics/tracing.rst \
 	Documentation/topics/usdt-probes.rst \
 	Documentation/topics/userspace-checksum-offloading.rst \
@@ -162,6 +163,7 @@ RST_MANPAGES = \
 	ovs-actions.7.rst \
 	ovs-appctl.8.rst \
 	ovs-ctl.8.rst \
+	ovs-flowviz.8.rst \
 	ovs-l3ping.8.rst \
 	ovs-parse-backtrace.8.rst \
 	ovs-pki.8.rst \

diff --git a/Documentation/conf.py b/Documentation/conf.py
@@ -112,6 +112,8 @@
 # Define the canonical URL for our domain configured on Read the Docs.
 html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
 
+option_emphasise_placeholders = True
+
 # Tell Jinja2 templates the build is running on Read the Docs.
 html_context = {}
 if os.environ.get("READTHEDOCS", "") == "True":
@@ -128,6 +130,8 @@
      u'utility for configuring running Open vSwitch daemons'),
     ('ovs-ctl.8',
      u'OVS startup helper script'),
+    ('ovs-flowviz.8',
+     u'utility for visualizing OpenFlow and datapath flows'),
     ('ovs-l3ping.8',
      u'check network deployment for L3 tunneling problems'),
     ('ovs-parse-backtrace.8',

diff --git a/Documentation/ref/index.rst b/Documentation/ref/index.rst
@@ -42,6 +42,7 @@ time:
    ovs-actions.7
    ovs-appctl.8
    ovs-ctl.8
+   ovs-flowviz.8
    ovs-l3ping.8
    ovs-pki.8
    ovs-sim.1