diff mbox series

[ovs-dev,v1,14/20] ovn-sbctl: Correct description of chassis-del.

Message ID 20260901135638.290353-15-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
The docs for chassis-del mentions it deletes chassis's gateway_ports,
but there is no table or column gateway_ports and the gateway_ports
column was removed from ovn-sb.ovsschema by c4a480117b6a3.

Assisted-by: Claude Opus 4.6, Claude Code
Fixes: 9a09a965444e ("ovn-sbctl: Add ovn-sbctl.")
Signed-off-by: Jacob Tanenbaum <jtanenba@redhat.com>
---
 utilities/ovn-sbctl.8.xml | 3 +--
 utilities/ovn-sbctl.c     | 1 -
 2 files changed, 1 insertion(+), 3 deletions(-)

Comments

Mark Michelson Sept. 2, 2026, 5:28 p.m. UTC | #1
Hi Jacob, I have one minor finding below.

Also, I got curious about the claim about deleting gateway ports, so I
had a look at the commit history.

As you noted, commit c4a480117b6a3 removed gateway ports from the SB
schema. This commit was made before ovn-sbctl existed. So when
ovn-sbctl was created, it incorrectly claimed that chassis-del removed
gateway ports from the very start. Also when ovn-sbctl was created,
the documentation's claim that encaps were deleted was also incorrect.
This was added about a week later.

Weird stuff.

On Tue, Sep 1, 2026 at 2:02 PM Jacob Tanenbaum via dev
<ovs-dev@openvswitch.org> wrote:
>
> The docs for chassis-del mentions it deletes chassis's gateway_ports,
> but there is no table or column gateway_ports and the gateway_ports
> column was removed from ovn-sb.ovsschema by c4a480117b6a3.
>
> Assisted-by: Claude Opus 4.6, Claude Code
> Fixes: 9a09a965444e ("ovn-sbctl: Add ovn-sbctl.")
> Signed-off-by: Jacob Tanenbaum <jtanenba@redhat.com>
> ---
>  utilities/ovn-sbctl.8.xml | 3 +--
>  utilities/ovn-sbctl.c     | 1 -
>  2 files changed, 1 insertion(+), 3 deletions(-)
>
> diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml
> index ce1d4939a..7e4b3ea78 100644
> --- a/utilities/ovn-sbctl.8.xml
> +++ b/utilities/ovn-sbctl.8.xml
> @@ -324,8 +324,7 @@
>        <dt>[<code>--if-exists</code>] <code>chassis-del <var>chassis</var></code></dt>
>        <dd>
>          <p>
> -          Deletes <var>chassis</var> and its <var>encaps</var> and
> -          <var>gateway_ports</var>.
> +          Deletes <var>chassis</var> and its <var>encaps</var>

Missing . at the end of the sentence.



>          </p>
>
>          <p>
> diff --git a/utilities/ovn-sbctl.c b/utilities/ovn-sbctl.c
> index 73681c9de..e33d302ca 100644
> --- a/utilities/ovn-sbctl.c
> +++ b/utilities/ovn-sbctl.c
> @@ -99,7 +99,6 @@ Chassis commands:\n\
>                                             CHASSIS with ENCAP-TYPE tunnels\n\
>                                             and ENCAP-IP\n\
>    chassis-del CHASSIS         delete CHASSIS and all of its encaps\n\
> -                              and gateway_ports\n\
>  \n\
>  Port binding commands:\n\
>    lsp-bind PORT CHASSIS       bind logical port PORT to CHASSIS\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 ce1d4939a..7e4b3ea78 100644
--- a/utilities/ovn-sbctl.8.xml
+++ b/utilities/ovn-sbctl.8.xml
@@ -324,8 +324,7 @@ 
       <dt>[<code>--if-exists</code>] <code>chassis-del <var>chassis</var></code></dt>
       <dd>
         <p>
-          Deletes <var>chassis</var> and its <var>encaps</var> and
-          <var>gateway_ports</var>.
+          Deletes <var>chassis</var> and its <var>encaps</var>
         </p>
 
         <p>
diff --git a/utilities/ovn-sbctl.c b/utilities/ovn-sbctl.c
index 73681c9de..e33d302ca 100644
--- a/utilities/ovn-sbctl.c
+++ b/utilities/ovn-sbctl.c
@@ -99,7 +99,6 @@  Chassis commands:\n\
                                            CHASSIS with ENCAP-TYPE tunnels\n\
                                            and ENCAP-IP\n\
   chassis-del CHASSIS         delete CHASSIS and all of its encaps\n\
-                              and gateway_ports\n\
 \n\
 Port binding commands:\n\
   lsp-bind PORT CHASSIS       bind logical port PORT to CHASSIS\n\