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>

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index f160b01..329ea31 100644 (file)
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -2070,8 +2070,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"
@@ -2081,8 +2082,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
index 63ed005..4393a16 100644 (file)
--- 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>