[ovs-dev] [PATCH] ovn-sb.xml: Reorganize Port_Binding documentation.

[Ben Pfaff]

On Tue, Oct 06, 2015 at 11:17:07PM +0100, Russell Bryant wrote:
> On 10/06/2015 09:32 PM, Ben Pfaff wrote:
> > This takes advantage of column grouping and the ability to document a key
> > within a column.
> > 
> > Signed-off-by: Ben Pfaff <blp at nicira.com>
> 
> I like the grouping.  The only issue I saw is that "tag" is only
> included under "Nested Containers".  It's now used for localnet ports,
> as well.

You're right, that's not really clear.

I applied the following incremental and I'll apply this to master soon:

diff --git a/ovn/ovn-sb.xml b/ovn/ovn-sb.xml
index d1b37f0..f9e21c6 100644
--- a/ovn/ovn-sb.xml
+++ b/ovn/ovn-sb.xml
@@ -1060,6 +1060,12 @@
           another chassis.
         </p>
       </column>
+
+      <column name="tag">
+        If set, indicates that the port represents a connection to a specific
+        VLAN on a locally accessible network. The VLAN ID is used to match
+        incoming traffic and is also added to outgoing traffic.
+      </column>
     </group>
 
     <group title="VTEP Options">
@@ -1080,8 +1086,11 @@
 
     <group title="Nested Containers">
       <p>
-        These columns support containers nested within a VM.  They are empty
-        for containers or VMs that run directly on a hypervisor.
+        These columns support containers nested within a VM.  Specifically,
+        they are used when <ref column="type"/> is empty and <ref
+        column="logical_port"/> identifies the interface of a container spawned
+        inside a VM.  They are empty for containers or VMs that run directly on
+        a hypervisor.
       </p>
 
       <column name="parent_port">
@@ -1093,19 +1102,13 @@
 
       <column name="tag">
         <p>
-          When <ref column="type"/> is empty and <ref column="logical_port"/>
-          identifies the interface of a container spawned inside a VM, this
-          column identifies the VLAN tag in the network traffic associated with
-          that container's network interface. It is left empty if <ref
-          column="logical_port"/> belongs to a VM or a container created in the
-          hypervisor.
+          Identifies the VLAN tag in the network traffic associated with that
+          container's network interface.
         </p>
 
         <p>
-          When <ref column="type"/> is set to <code>localnet</code>, this can
-          be set to indicate that the port represents a connection to a
-          specific VLAN on a locally accessible network. The VLAN ID is used to
-          match incoming traffic and is also added to outgoing traffic.
+          This column is used for a different purpose when <ref column="type"/>
+          is <code>localnet</code> (see <code>Localnet Options</code>, above).
         </p>
       </column>
     </group>