diff mbox series

[ovs-dev] ovn-nbctl: Fix documentation typo

Message ID CAGEh7+v+hfPacKcDPO=OASm=zVXyqicd9W1jKONdwS-Mdc5UNw@mail.gmail.com
State Changes Requested
Headers show
Series [ovs-dev] ovn-nbctl: Fix documentation typo | expand

Commit Message

Roberto Bartzen Acosta March 16, 2023, 5:51 p.m. UTC
Typo fix in the ovn-nbctl man page.
According to the ovn-nbctl man8 (NAT):
[--may-exist] [--stateless] [--gateway_port=GATEWAY_PORT]
lr-nat-add router type external_ip logical_ip [logical_port external_mac]

Result using man page syntax:
ovn-nbctl: unrecognized option '--gateway_port'

The option expected by the implementation is:
--gateway-port


Fixes: 2d942be ("northd: Add support for NAT with multiple DGP")
Signed-off-by: Roberto Acosta <rbartzen@gmail.com>
---
 utilities/ovn-nbctl.8.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

+      <dt>[<code>--may-exist</code>] [<code>--stateless</code>]
[<code>--gateway-port</code>=<var>GATEWAY_PORT</var>]
<code>lr-nat-add</code> <var>router</var> <var>type</var>
<var>external_ip</var> <var>logical_ip</var> [<var>logical_port</var>
<var>external_mac</var>]</dt>
       <dd>
         <p>
           Adds the specified NAT to <var>router</var>.

Comments

Numan Siddique March 23, 2023, 4:01 p.m. UTC | #1
On Fri, Mar 17, 2023 at 5:17 PM Roberto Bartzen Acosta
<rbartzen@gmail.com> wrote:
>
> Typo fix in the ovn-nbctl man page.
> According to the ovn-nbctl man8 (NAT):
> [--may-exist] [--stateless] [--gateway_port=GATEWAY_PORT]
> lr-nat-add router type external_ip logical_ip [logical_port external_mac]
>
> Result using man page syntax:
> ovn-nbctl: unrecognized option '--gateway_port'
>
> The option expected by the implementation is:
> --gateway-port
>
>
> Fixes: 2d942be ("northd: Add support for NAT with multiple DGP")
> Signed-off-by: Roberto Acosta <rbartzen@gmail.com>


Thanks for the patch.  But looks like the patch is corrupted.  I'm not
able to apply it cleanly.

Can you please resend it ?

You could open a PR if you have issues generating a patch.

Numan
> ---
>  utilities/ovn-nbctl.8.xml | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/utilities/ovn-nbctl.8.xml b/utilities/ovn-nbctl.8.xml
> index 72d4088f0..54dbdb791 100644
> --- a/utilities/ovn-nbctl.8.xml
> +++ b/utilities/ovn-nbctl.8.xml
> @@ -1151,7 +1151,7 @@
>      <h2>NAT Commands</h2>
>
>      <dl>
> -      <dt>[<code>--may-exist</code>] [<code>--stateless</code>]
> [<code>--gateway_port</code>=<var>GATEWAY_PORT</var>]
> <code>lr-nat-add</code> <var>router</var> <var>type</var>
> <var>external_ip</var> <var>logical_ip</var> [<var>logical_port</var>
> <var>external_mac</var>]</dt>
> +      <dt>[<code>--may-exist</code>] [<code>--stateless</code>]
> [<code>--gateway-port</code>=<var>GATEWAY_PORT</var>]
> <code>lr-nat-add</code> <var>router</var> <var>type</var>
> <var>external_ip</var> <var>logical_ip</var> [<var>logical_port</var>
> <var>external_mac</var>]</dt>
>        <dd>
>          <p>
>            Adds the specified NAT to <var>router</var>.
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
diff mbox series

Patch

diff --git a/utilities/ovn-nbctl.8.xml b/utilities/ovn-nbctl.8.xml
index 72d4088f0..54dbdb791 100644
--- a/utilities/ovn-nbctl.8.xml
+++ b/utilities/ovn-nbctl.8.xml
@@ -1151,7 +1151,7 @@ 
     <h2>NAT Commands</h2>

     <dl>
-      <dt>[<code>--may-exist</code>] [<code>--stateless</code>]
[<code>--gateway_port</code>=<var>GATEWAY_PORT</var>]
<code>lr-nat-add</code> <var>router</var> <var>type</var>
<var>external_ip</var> <var>logical_ip</var> [<var>logical_port</var>
<var>external_mac</var>]</dt>