diff mbox series

[ovs-dev,2/2] ovn-sb: Fix documentation errors in Port_Binding table

Message ID 20210805130907.1715667-2-mark.d.gray@redhat.com
State Superseded, archived
Headers show
Series [ovs-dev,1/2] lflow: Refactor OpenFlow hairpin flows | expand

Checks

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

Commit Message

Mark Gray Aug. 5, 2021, 1:09 p.m. UTC
* The "mac" column may also contain IP addresses.
* Logical router ports and logical switch ports must not
  share names.

Signed-off-by: Mark Gray <mark.d.gray@redhat.com>
---
 ovn-sb.xml | 21 ++++++---------------
 1 file changed, 6 insertions(+), 15 deletions(-)

Comments

Numan Siddique Aug. 5, 2021, 8:48 p.m. UTC | #1
On Thu, Aug 5, 2021 at 9:09 AM Mark Gray <mark.d.gray@redhat.com> wrote:
>
> * The "mac" column may also contain IP addresses.
> * Logical router ports and logical switch ports must not
>   share names.
>
> Signed-off-by: Mark Gray <mark.d.gray@redhat.com>

Thanks for fixing the documentation errors.  As this patch is
independent of the first patch of this series,
I went ahead and applied this patch to the main branch.

Numan

> ---
>  ovn-sb.xml | 21 ++++++---------------
>  1 file changed, 6 insertions(+), 15 deletions(-)
>
> diff --git a/ovn-sb.xml b/ovn-sb.xml
> index e6ce243cfa91..f3b6307e3c2f 100644
> --- a/ovn-sb.xml
> +++ b/ovn-sb.xml
> @@ -2785,8 +2785,8 @@ tcp.flags = RST;
>          from <ref table="Logical_Router_Port" column="name"
>          db="OVN_Northbound"/> in the OVN_Northbound database's <ref
>          table="Logical_Router_port" db="OVN_Northbound"/> table.  (This means
> -        that logical switch ports and router port names must share names in an
> -        OVN deployment.) OVN does not prescribe a particular format for the
> +        that logical switch ports and router port names must not share names in
> +        an OVN deployment.) OVN does not prescribe a particular format for the
>          logical port ID.
>        </column>
>
> @@ -2887,19 +2887,10 @@ tcp.flags = RST;
>        </column>
>
>        <column name="mac">
> -        <p>
> -          The Ethernet address or addresses used as a source address on the
> -          logical port, each in the form
> -          <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
> -          The string <code>unknown</code> is also allowed to indicate that the
> -          logical port has an unknown set of (additional) source addresses.
> -        </p>
> -
> -        <p>
> -          A VM interface would ordinarily have a single Ethernet address.  A
> -          gateway port might initially only have <code>unknown</code>, and then
> -          add MAC addresses to the set as it learns new source addresses.
> -        </p>
> +        This column is a misnomer as it may contain MAC addresses and IP
> +        addresses. It is copied from the <code>addresses</code> column in the
> +        <code>Logical_Switch_Port</code> table in the Northbound database. It
> +        follows the same format as that column.
>        </column>
>
>        <column name="type">
> --
> 2.27.0
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
Mark Gray Aug. 6, 2021, 7:18 a.m. UTC | #2
On 05/08/2021 21:48, Numan Siddique wrote:
> Thanks for fixing the documentation errors.  As this patch is
> independent of the first patch of this series,
> I went ahead and applied this patch to the main branch.
> 
> Numan
> 

Thanks Numan
diff mbox series

Patch

diff --git a/ovn-sb.xml b/ovn-sb.xml
index e6ce243cfa91..f3b6307e3c2f 100644
--- a/ovn-sb.xml
+++ b/ovn-sb.xml
@@ -2785,8 +2785,8 @@  tcp.flags = RST;
         from <ref table="Logical_Router_Port" column="name"
         db="OVN_Northbound"/> in the OVN_Northbound database's <ref
         table="Logical_Router_port" db="OVN_Northbound"/> table.  (This means
-        that logical switch ports and router port names must share names in an
-        OVN deployment.) OVN does not prescribe a particular format for the
+        that logical switch ports and router port names must not share names in
+        an OVN deployment.) OVN does not prescribe a particular format for the
         logical port ID.
       </column>
 
@@ -2887,19 +2887,10 @@  tcp.flags = RST;
       </column>
 
       <column name="mac">
-        <p>
-          The Ethernet address or addresses used as a source address on the
-          logical port, each in the form
-          <var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>:<var>xx</var>.
-          The string <code>unknown</code> is also allowed to indicate that the
-          logical port has an unknown set of (additional) source addresses.
-        </p>
-
-        <p>
-          A VM interface would ordinarily have a single Ethernet address.  A
-          gateway port might initially only have <code>unknown</code>, and then
-          add MAC addresses to the set as it learns new source addresses.
-        </p>
+        This column is a misnomer as it may contain MAC addresses and IP
+        addresses. It is copied from the <code>addresses</code> column in the
+        <code>Logical_Switch_Port</code> table in the Northbound database. It
+        follows the same format as that column.
       </column>
 
       <column name="type">