Hi Jacob, I have a couple of notes below.

On Fri, Aug 21, 2026 at 3:58 PM Jacob Tanenbaum via dev
<[email protected]> wrote:
>
> when introduced the the example for put_fdb() in the docs showed the

s/when introduced the the/When introduced, the/

> second argument to be arp.spa which is a 32-bit IP address but the
> parser requires a 48-bit MAC address. Correct the example to use the
> correct field.
>
> Fixes: f819ce8fa2a0 ("MAC learning: Add new actions - put_fdb, get_fdb and 
> lookup_fdb.")
> Assisted-by: Claude Opus 4.6, Claude Code
> Signed-off-by: Jacob Tanenbaum <[email protected]>
> ---
>  ovn-sb.xml | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/ovn-sb.xml b/ovn-sb.xml
> index d19c644ee..be601faad 100644
> --- a/ovn-sb.xml
> +++ b/ovn-sb.xml
> @@ -1800,7 +1800,7 @@
>              fdb table, setting its logical port key to <var>P</var>.

I saw this bit peeking through, and I noticed a couple of common
issues in the paragraphs describing put_fdb:
* There is never a definite article preceding the phrase "fdb table".
For instance, the line above is "Adds or updates the entry ... in fdb
table" instead of "Adds or updates the entry ... in the fdb table"
* Any time "fdb table" is referenced, it should use a <ref> tag
instead: <ref table="FDB"/>. This will cause the manpage to underline
the entry, and it will properly capitalize "FDB" as the table is
named.

I suspect this may be the case for other FDB-related actions as well,
so double-check those areas, too.


>            </p>
>
> -          <p><b>Example:</b> <code>put_fdb(inport, arp.spa);</code></p>
> +          <p><b>Example:</b> <code>put_fdb(inport, eth.src);</code></p>
>          </dd>
>
>          <dt>
> --
> 2.55.0
>
> _______________________________________________
> dev mailing list
> [email protected]
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to