[ovs-dev] [PATCH V10] ovn-controller-vtep: Update related documentation.

[Justin Pettit]

> On Sep 13, 2015, at 4:34 PM, Alex Wang <ee07b291 at gmail.com> wrote:
> 
> +      Next, the <code>ovn-controller-vtep</code> will keep reacting to the
> +      configuration change in the <code>Port_Binding</code> in the
> +      <code>OVN_Northbound</code> database, and updating the
> +      <code>Ucast_Macs_Remote</code> table in the <code>VTEP</code> database.
> +      This allows the VTEP gateway understand  where to forward the unicast
> +      traffic coming from the extended external network.

s/understand/to understand

It looks like there's an extra space after "understand".

> +      When the <code>ovn-controller-vtep</code> is terminated, all related
> +      configurations in the <code>OVN_Southbound</code> database and
> +      the <code>VTEP</code> database will be cleaned, including
> +      <code>Chassis</code> table entries for all registered VTEP gateways
> +      and their port bindings, and all <code>Ucast_Macs_Remote</code> table
> +      entries and the <code>Logical_Switch</code> tunnel keys,

This sentence ends with a comma.

> +        <dt><code>vtep</code></dt>
> +        <dd>A port to a logical switch on a VTEP gateway.  In order
> +        to get this port correctly recognized by the OVN controller, the
> +        <ref column="options" table="Logical_Port"/>:vtep-physical-switch
> +        and <ref column="options" table="Logical_Port"/>:vtep-logical-switch
> +        must also be defined.</dd>

Should those key names be wrapped in "<code>" blocks?

> @@ -279,7 +307,7 @@
> 
>     <column name="action">
>       <p>The action to take when the ACL rule matches:</p>
> -      
> +

Is this a newline change?

>       <column name="vtep_logical_switches">
> -        Stores all vtep logical switch names connected by this gateway
> -        chassis.
> +        Stores all VTEP logical switch names connected by this gateway
> +        chassis.  The <ref table="Port_Binding"/> table entry with
> +        <ref column="options" table="Port_Binding"/>:vtep-physical-switch
> +        equal <ref table="Chassis"/> <ref column="name" table="Chassis"/>,
> +        and <ref column="options" table="Port_Binding"/>:vtep-logical-switch
> +        value in <ref table="Chassis"/>
> +        <ref column="vtep_logical_switches" table="Chassis"/>, will be
> +        associated with this <ref table="Chassis"/>.

Same question about whether those keys should be wrapped in "<code>" blocks.

> +        <dt><code>vtep</code></dt>
> +        <dd>A port to a logical switch on a VTEP gateway chassis.  In order
> +        to get this port correctly recognized by the OVN controller, the
> +        <ref column="options" table="Port_Binding"/>:vtep-physical-switch
> +        and <ref column="options" table="Port_Binding"/>:vtep-logical-switch
> +        must also be defined.</dd>

Ditto.

> -      <p>
> -        <code>$ ovs-vsctl set open
> -        . external-ids:ovn-bridge-mappings=physnet1:br-eth0,physnet2:br-eth1</code>
> -      </p>
> +          <p>
> +            <code>$ ovs-vsctl set open
> +            . external-ids:ovn-bridge-mappings=physnet1:br-eth0,
> +            physnet2:br-eth1</code>
> +          </p>

I'm not sure about the formatting, but will these show up the same?  Since it looks like there shouldn't be a newline after the comma, it's probably better not to introduce one here, even if it displays okay.

Thanks for doing this series!

Acked-by: Justin Pettit <jpettit at nicira.com>

--Justin