On Fri, Dec 06, 2024 at 08:38:49PM +0000, Kevin Traynor wrote:
> On 05/12/2024 17:05, Ilya Maximets wrote:
> > On 12/5/24 15:54, Kevin Traynor wrote:
> >> Hi,
> >>
> >> I'm hitting doc build error [1] with Sphinx v1.7.6 on RHEL 8.
> >>
> >> The issue is with duplicate options for ovs-flowviz because the options
> >> are described for different formats. e.g.
> >> # grep 'option:: -h,' ovs-flowviz.8.rst
> >> .. option:: -h, --help
> >> .. option:: -h, --heat-map
> >> .. option:: -h, --heat-map
> >> .. option:: -h, --html
> >>
> >> I tried to suppress the autosectionlabel warnings but that option was
> >> introduced in Sphinx 2.1 :( There is probably some easy if you know it
> >> fix, but I spent a bit of time searching/trying and I didn't come up
> >> with something. Any ideas ?
> >>
> >
> > Do you know from which version such non-duplication duplications are
> > correctly handled?
> >
In theory, the correct way would be to change the program using the
("program::" directive).
Unfortunately, sphinx does not have notion of subcommand. I guess
something like this should work:
---
diff --git a/Documentation/ref/ovs-flowviz.8.rst
b/Documentation/ref/ovs-flowviz.8.rst
index fc850e1d3..34bfbebde 100644
--- a/Documentation/ref/ovs-flowviz.8.rst
+++ b/Documentation/ref/ovs-flowviz.8.rst
@@ -52,7 +52,7 @@ them in one of the predefined *format*\ s.
Options
=======
-.. program: ovs-flowviz
+.. program:: ovs-flowviz
.. option:: -h, --help
@@ -84,7 +84,7 @@ Options
The filtering syntax is detailed in `Filtering Syntax`_.
-.. option:: -h <filter>, --highlight <filter>
+.. option:: -s <filter>, --highlight <filter>
Highlight the flows that match the provided *filter* expression.
@@ -151,6 +151,8 @@ option.
Arguments:
+.. program:: ovs-flowviz [datapath|openflow] console
+
.. option:: -h, --heat-map
Color of the packet and byte counters to reflect their relative size.
@@ -201,6 +203,9 @@ A logical block is a set of flows that have:
Arguments:
+
+.. program:: ovs-flowviz openflow logic
+
.. option:: -s, --show-flows
Show all the flows under each logical block.
@@ -277,6 +282,8 @@ same tree-like flow hierarchy that the ``tree``
format prints.
Arguments:
+.. program:: ovs-flowviz datapath console
+
.. option:: -h, --html
Print the graphviz format as an svg image alongside an interactive HTML
_______________________________________________
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
