diff mbox series

[ovs-dev,v1,17/20] ovn-sbctl: Correct what is included for --vflows.

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

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success

Commit Message

Jacob Tanenbaum Sept. 1, 2026, 1:56 p.m. UTC
Load balancers where added to vflows and the documentation was not
updated to reflect that.

Assisted-by: Claude Opus 4.6, Claude Code
Fixes: 4da6881b6431 ("sbctl: Add Load Balancer support for vflows option.")
Signed-off-by: Jacob Tanenbaum <jtanenba@redhat.com>
---
 utilities/ovn-sbctl.8.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Mark Michelson Sept. 2, 2026, 5:28 p.m. UTC | #1
Hi Jacob, I have a couple of findings below.

On Tue, Sep 1, 2026 at 12:00 PM Jacob Tanenbaum via dev
<ovs-dev@openvswitch.org> wrote:
>
> Load balancers where added to vflows and the documentation was not

s/where/were/

> updated to reflect that.
>
> Assisted-by: Claude Opus 4.6, Claude Code
> Fixes: 4da6881b6431 ("sbctl: Add Load Balancer support for vflows option.")
> Signed-off-by: Jacob Tanenbaum <jtanenba@redhat.com>
> ---
>  utilities/ovn-sbctl.8.xml | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml
> index 3afcf5dc3..0b6aa4758 100644
> --- a/utilities/ovn-sbctl.8.xml
> +++ b/utilities/ovn-sbctl.8.xml
> @@ -425,8 +425,9 @@
>            records directly used for generating OpenFlow flows are also
>            listed. This includes: <var>port-bindings</var>,
>            <var>mac-bindings</var>, <var>multicast-groups</var>,
> -          <var>chassis</var>.  The <code>--ovs</code> and <code>--stats</code>
> -          can also be used in conjunction with <code>--vflows</code>.
> +          <var>chassis</var> and <var>load-balancers</var>.  The
> +          <code>--ovs</code> and <code>--stats</code> can also be used in
> +          conjunction with <code>--vflows</code>.

When rendered, this ends up saying "The --ovs and --stats can also be
used in conjunction with --vflows". To me, this reads a bit odd. I
think it can be changed to one of two options to make it sound more
natural:

* The --ovs and --stats options can also be used in conjunction with --vflows.
* --ovs and --stats can also be used in conjunction with --vflows.


>          </p>
>        </dd>
>
> --
> 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 3afcf5dc3..0b6aa4758 100644
--- a/utilities/ovn-sbctl.8.xml
+++ b/utilities/ovn-sbctl.8.xml
@@ -425,8 +425,9 @@ 
           records directly used for generating OpenFlow flows are also
           listed. This includes: <var>port-bindings</var>,
           <var>mac-bindings</var>, <var>multicast-groups</var>,
-          <var>chassis</var>.  The <code>--ovs</code> and <code>--stats</code>
-          can also be used in conjunction with <code>--vflows</code>.
+          <var>chassis</var> and <var>load-balancers</var>.  The
+          <code>--ovs</code> and <code>--stats</code> can also be used in
+          conjunction with <code>--vflows</code>.
         </p>
       </dd>