diff mbox

[ovs-dev] bfd: improve ovs-vswitchd.conf.db(5) manpage

Message ID 1445571788-15103-1-git-send-email-azhou@nicira.com
State Accepted
Headers show

Commit Message

Andy Zhou Oct. 23, 2015, 3:43 a.m. UTC
Use the wording from RFC 5880 to describe the "diagnostic" and
"remote_diagnostic" fields.

Reported-by: Justin Pettit <jpettit@nicira.com>
Signed-off-by: Andy Zhou <azhou@nicira.com>
---
 vswitchd/vswitch.xml | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

Comments

Justin Pettit Nov. 3, 2015, 6:53 p.m. UTC | #1
> On Oct 22, 2015, at 8:43 PM, Andy Zhou <azhou@nicira.com> wrote:
> 
> Use the wording from RFC 5880 to describe the "diagnostic" and
> "remote_diagnostic" fields.
> 
> Reported-by: Justin Pettit <jpettit@nicira.com>
> Signed-off-by: Andy Zhou <azhou@nicira.com>
> ---
> vswitchd/vswitch.xml | 13 +++++++------
> 1 file changed, 7 insertions(+), 6 deletions(-)
> 
> diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
> index 4dbd9e3..395d8f2 100644
> --- a/vswitchd/vswitch.xml
> +++ b/vswitchd/vswitch.xml
> @@ -2578,9 +2578,10 @@
>         </column>
> 
>         <column name="bfd_status" key="diagnostic">
> -          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].
> +          A diagnostic code specifying the local system's reason for the
> +          last change in session state. It allows the remote system to
> +          determine the reason that the previous session failed.  The error
> +          messages are defined in section 4.1 of [RFC 5880].
>         </column>

Do you think the middle sentence is necessary?  It sounds like the remote side would read this column, but I doubt that's the case.

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

--Justin
Andy Zhou Nov. 3, 2015, 7:07 p.m. UTC | #2
On Tue, Nov 3, 2015 at 10:53 AM, Justin Pettit <jpettit@nicira.com> wrote:
>
>> On Oct 22, 2015, at 8:43 PM, Andy Zhou <azhou@nicira.com> wrote:
>>
>> Use the wording from RFC 5880 to describe the "diagnostic" and
>> "remote_diagnostic" fields.
>>
>> Reported-by: Justin Pettit <jpettit@nicira.com>
>> Signed-off-by: Andy Zhou <azhou@nicira.com>
>> ---
>> vswitchd/vswitch.xml | 13 +++++++------
>> 1 file changed, 7 insertions(+), 6 deletions(-)
>>
>> diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
>> index 4dbd9e3..395d8f2 100644
>> --- a/vswitchd/vswitch.xml
>> +++ b/vswitchd/vswitch.xml
>> @@ -2578,9 +2578,10 @@
>>         </column>
>>
>>         <column name="bfd_status" key="diagnostic">
>> -          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].
>> +          A diagnostic code specifying the local system's reason for the
>> +          last change in session state. It allows the remote system to
>> +          determine the reason that the previous session failed.  The error
>> +          messages are defined in section 4.1 of [RFC 5880].
>>         </column>
>
> Do you think the middle sentence is necessary?  It sounds like the remote side would read this column, but I doubt that's the case.
>
I see. This is the wording from RFC 5880, but does not apply to OVS.
I will remove it.

> Acked-by: Justin Pettit <jpettit@nicira.com>
Thanks for the review. I will push with the change.
diff mbox

Patch

diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 4dbd9e3..395d8f2 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -2578,9 +2578,10 @@ 
         </column>
 
         <column name="bfd_status" key="diagnostic">
-          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].
+          A diagnostic code specifying the local system's reason for the
+          last change in session state. It allows the remote system to
+          determine the reason that the previous session failed.  The error
+          messages are defined in section 4.1 of [RFC 5880].
         </column>
 
         <column name="bfd_status" key="remote_state"
@@ -2590,9 +2591,9 @@ 
         </column>
 
         <column name="bfd_status" key="remote_diagnostic">
-          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].
+          A diagnostic code specifying the remote system's reason for the
+          last change in session state. The error messages are defined in
+          section 4.1 of [RFC 5880].
         </column>
 
         <column name="bfd_status" key="flap_count"