bfd: Clarify the BFD diagnostic.

This commit adds more explanation for the bfd diagnostic and bfd remote diagnostic in vswitch and vtep documentation. Requested-by:Bruce Davie <bdavie@vmware.com> Signed-off-by: Alex Wang <alexw@nicira.com>
openvswitch · Aug 14, 2014 · 233b8b6 · 233b8b6
1 parent 623540e
commit 233b8b6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
@@ -2138,8 +2138,9 @@
 	</column>
 
 	<column name="bfd_status" key="diagnostic">
-	  In case of a problem, set to a short message that reports what the
-	  local BFD session thinks is wrong.
+	  In case of a problem, set to an error message that reports what the
+	  local BFD session thinks is wrong.  The error messages are defined
+	  in section 4.1 of [RFC 5880].
 	</column>
 
 	<column name="bfd_status" key="remote_state"
@@ -2149,8 +2150,9 @@
 	</column>
 
 	<column name="bfd_status" key="remote_diagnostic">
-	  In case of a problem, set to a short message that reports what the
-	  remote endpoint's BFD session thinks is wrong.
+	  In case of a problem, set to an error message that reports what the
+	  remote endpoint's BFD session thinks is wrong.  The error messages
+	  are defined in section 4.1 of [RFC 5880].
 	</column>
 
         <column name="bfd_status" key="flap_count"

diff --git a/vtep/vtep.xml b/vtep/vtep.xml
@@ -474,8 +474,9 @@
       </column>
 
       <column name="bfd_status" key="diagnostic">
-        In case of a problem, set to a short message that reports what the
-        local BFD session thinks is wrong.
+        In case of a problem, set to an error message that reports what the
+        local BFD session thinks is wrong.  The error messages are defined
+        in section 4.1 of [RFC 5880].
       </column>
 
       <column name="bfd_status" key="remote_state"
@@ -485,8 +486,9 @@
       </column>
 
       <column name="bfd_status" key="remote_diagnostic">
-        In case of a problem, set to a short message that reports what the
-        remote endpoint's BFD session thinks is wrong.
+        In case of a problem, set to an error message that reports what the
+        remote endpoint's BFD session thinks is wrong.  The error messages
+        are defined in section 4.1 of [RFC 5880].
       </column>
       </group>
     </group>