vswitch.xml: Improve description of forward-bpdu.

The description was at best incomplete and difficult to understand.

Reported-by: Brian Field <Brian_Field@cable.comcast.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>
Acked-by: Justin Pettit <jpettit@nicira.com>

diff --git a/AUTHORS b/AUTHORS
index 8fba915..1d2201c 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -216,6 +216,7 @@ Brad Hall               brad@nicira.com
 Brandon Heller          brandonh@stanford.edu
 Brendan Kelley          bkelley@nicira.com
 Brent Salisbury         brent.salisbury@gmail.com
+Brian Field             Brian_Field@cable.comcast.com
 Bryan Fulton            bryan@nicira.com
 Bryan Osoro             bosoro@nicira.com
 Cedric Hobbs            cedric@nicira.com

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 81e8b3f..3256ce0 100644 (file)
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -980,18 +980,47 @@
 
       <column name="other_config" key="forward-bpdu"
               type='{"type": "boolean"}'>
-        Option to allow forwarding of BPDU frames when NORMAL action is
-        invoked.  Frames with reserved Ethernet addresses (e.g. STP
-        BPDU) will be forwarded when this option is enabled and the
-        switch is not providing that functionality.  If STP is enabled
-        on the port, STP BPDUs will never be forwarded.  If the Open
-        vSwitch bridge is used to connect different Ethernet networks,
-        and if Open vSwitch node does not run STP, then this option
-        should be enabled.  Default is disabled, set to
-        <code>true</code> to enable.
-
-        The following destination MAC addresss will not be forwarded when this
-        option is enabled.
+
+       <p>
+          Controls forwarding of BPDUs and other network control frames when
+          NORMAL action is invoked.  When this option is <code>false</code> or
+          unset, frames with reserved Ethernet addresses (see table below) will
+          not be forwarded.  When this option is <code>true</code>, such frames
+          will not be treated specially.
+       </p>
+
+       <p>
+         The above general rule has the following exceptions:
+       </p>
+
+       <ul>
+         <li>
+           If STP is enabled on the bridge (see the <ref column="stp_enable"
+           table="Bridge"/> column in the <ref table="Bridge"/> table), the
+           bridge processes all received STP packets and never passes them to
+           OpenFlow or forwards them.  This is true even if STP is disabled on
+           an individual port.
+         </li>
+
+         <li>
+           If LLDP is enabled on an interface (see the <ref column="lldp"
+           table="Interface"/> column in the <ref table="Interface"/> table),
+           the interface processes received LLDP packets and never passes them
+           to OpenFlow or forwards them.
+         </li>
+       </ul>
+
+       <p>
+         Set this option to <code>true</code> if the Open vSwitch bridge
+         connects different Ethernet networks and is not configured to
+         participate in STP.
+       </p>
+
+        <p>
+         This option affects packets with the following destination MAC
+         addresses:
+       </p>
+
         <dl>
           <dt><code>01:80:c2:00:00:00</code></dt>
           <dd>IEEE 802.1D Spanning Tree Protocol (STP).</dd>