diff mbox series

[ovs-dev,v1,13/20] ovn-sbctl: Command ip-multicast-flush undocumented.

Message ID 20260901135638.290353-14-jtanenba@redhat.com
State Changes Requested
Headers show
Series ovn-sbctl: Review of ovn-sbctl documentation. | expand

Checks

Context Check Description
ovsrobot/apply-robot warning apply and check: warning
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/github-robot-_ovn-kubernetes success github build: passed

Commit Message

Jacob Tanenbaum Sept. 1, 2026, 1:56 p.m. UTC
Write the documentation for command ip-multicast-flush as it was not
written when the option was added.

Assisted-by: Claude Opus 4.6, Claude Code
Fixes: 70ff8243040f ("OVN: Add IGMP SB definitions and ovn-controller support")
Signed-off-by: Jacob Tanenbaum <jtanenba@redhat.com>
---
 utilities/ovn-sbctl.8.xml | 21 +++++++++++++++++++++
 utilities/ovn-sbctl.c     |  3 +++
 2 files changed, 24 insertions(+)

Comments

Mark Michelson Sept. 2, 2026, 5:28 p.m. UTC | #1
Hi Jacob.

The indentation on this new section is not consistent with the rest of
the document. It appears you have used 4-space indentation instead of
2-space indentation.


On Tue, Sep 1, 2026 at 11:57 AM Jacob Tanenbaum via dev
<ovs-dev@openvswitch.org> wrote:
>
> Write the documentation for command ip-multicast-flush as it was not
> written when the option was added.
>
> Assisted-by: Claude Opus 4.6, Claude Code
> Fixes: 70ff8243040f ("OVN: Add IGMP SB definitions and ovn-controller support")
> Signed-off-by: Jacob Tanenbaum <jtanenba@redhat.com>
> ---
>  utilities/ovn-sbctl.8.xml | 21 +++++++++++++++++++++
>  utilities/ovn-sbctl.c     |  3 +++
>  2 files changed, 24 insertions(+)
>
> diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml
> index 7a68d5898..ce1d4939a 100644
> --- a/utilities/ovn-sbctl.8.xml
> +++ b/utilities/ovn-sbctl.8.xml
> @@ -437,6 +437,27 @@
>        <dd>Prints the number of logical flows per table and per datapath.</dd>
>      </dl>
>
> +    <h2>IP Multicast Commands</h2>
> +
> +    <dl>
> +        <dt><code>ip-multicast-flush</code> [<var>switch</var>]</dt>
> +        <dd>
> +            <p>
> +            Flushes the learned IP multicast groups for the logical switch
> +            identified by <var>switch</var>, which may be given as a UUID or
> +            as a datapath name.  If <var>switch</var> is not specified, flushes
> +            learned multicast groups for all logical switches.
> +            </p>
> +
> +            <p>
> +            This works by incrementing the <code>seq_no</code> column of
> +            the <code>IP_Multicast</code> record for the datapath.
> +            <code>ovn-controller</code> monitors this value and flushes
> +            its locally learned multicast groups when it detects a change.
> +            </p>
> +        </dd>
> +    </dl>
> +
>      <h2>Remote Connectivity Commands</h2>
>
>      <p>
> diff --git a/utilities/ovn-sbctl.c b/utilities/ovn-sbctl.c
> index c06bc435c..73681c9de 100644
> --- a/utilities/ovn-sbctl.c
> +++ b/utilities/ovn-sbctl.c
> @@ -110,6 +110,9 @@ Logical flow commands:\n\
>    dump-flows  [DATAPATH] [LFLOW...] alias for lflow-list\n\
>    count-flows [DATAPATH]            count logical flows for DATAPATH\n\
>  \n\
> +IP multicast commands:\n\
> +  ip-multicast-flush [SWITCH]     flush learned multicast groups\n\
> +\n\
>  Connection commands:\n\
>    get-connection             print the connections\n\
>    del-connection             delete the connections\n\
> --
> 2.55.0
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
diff mbox series

Patch

diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml
index 7a68d5898..ce1d4939a 100644
--- a/utilities/ovn-sbctl.8.xml
+++ b/utilities/ovn-sbctl.8.xml
@@ -437,6 +437,27 @@ 
       <dd>Prints the number of logical flows per table and per datapath.</dd>
     </dl>
 
+    <h2>IP Multicast Commands</h2>
+
+    <dl>
+        <dt><code>ip-multicast-flush</code> [<var>switch</var>]</dt>
+        <dd>
+            <p>
+            Flushes the learned IP multicast groups for the logical switch
+            identified by <var>switch</var>, which may be given as a UUID or
+            as a datapath name.  If <var>switch</var> is not specified, flushes
+            learned multicast groups for all logical switches.
+            </p>
+
+            <p>
+            This works by incrementing the <code>seq_no</code> column of
+            the <code>IP_Multicast</code> record for the datapath.
+            <code>ovn-controller</code> monitors this value and flushes
+            its locally learned multicast groups when it detects a change.
+            </p>
+        </dd>
+    </dl>
+
     <h2>Remote Connectivity Commands</h2>
 
     <p>
diff --git a/utilities/ovn-sbctl.c b/utilities/ovn-sbctl.c
index c06bc435c..73681c9de 100644
--- a/utilities/ovn-sbctl.c
+++ b/utilities/ovn-sbctl.c
@@ -110,6 +110,9 @@  Logical flow commands:\n\
   dump-flows  [DATAPATH] [LFLOW...] alias for lflow-list\n\
   count-flows [DATAPATH]            count logical flows for DATAPATH\n\
 \n\
+IP multicast commands:\n\
+  ip-multicast-flush [SWITCH]     flush learned multicast groups\n\
+\n\
 Connection commands:\n\
   get-connection             print the connections\n\
   del-connection             delete the connections\n\