[ovs-dev] [PATCH ovn] northd: improve OVN BFD documentation

[Ben Pfaff]

On Mon, Feb 08, 2021 at 11:49:03AM +0100, Lorenzo Bianconi wrote:
> Signed-off-by: Lorenzo Bianconi <lorenzo.bianconi at redhat.com>

Thanks!

Acked-by: Ben Pfaff <blp at ovn.org>

I suggest folding in the following as well to make it clearer the roles
of the different groups of columns.

diff --git a/ovn-nb.xml b/ovn-nb.xml
index 58083f101445..cd297a12abcb 100644
--- a/ovn-nb.xml
+++ b/ovn-nb.xml
@@ -3763,6 +3763,10 @@
     </p>
 
     <group title="Configuration">
+      <p>
+        <code>ovn-northd</code> reads configuration from these columns.
+      </p>
+
       <column name="logical_port">
         OVN logical port when BFD engine is running.
       </column>
@@ -3802,6 +3806,10 @@
     </group>
 
     <group title="Status Reporting">
+      <p>
+        <code>ovn-northd</code> writes BFD status into these columns.
+      </p>
+
       <column name="status">
         <p>
           BFD port logical states. Possible values are: