[ovs-dev] [PATCH ovn 1/3] ovn-northd-ddlog: Document --ddlog-record option.

[Ben Pfaff]

Signed-off-by: Ben Pfaff <blp at ovn.org>
---
 northd/ovn-northd-ddlog.c |  1 +
 northd/ovn-northd.8.xml   | 10 ++++++++++
 2 files changed, 11 insertions(+)

diff --git a/northd/ovn-northd-ddlog.c b/northd/ovn-northd-ddlog.c
index b7d2c8a5ef8d..c79e15312b64 100644
--- a/northd/ovn-northd-ddlog.c
+++ b/northd/ovn-northd-ddlog.c
@@ -1049,6 +1049,7 @@ Options:\n\
                             (default: %s)\n\
   --ovnsb-db=DATABASE       connect to ovn-sb database at DATABASE\n\
                             (default: %s)\n\
+  --ddlog-record=FILE.TXT   record db changes to replay later for debugging\n\
   --unixctl=SOCKET          override default control socket name\n\
   -h, --help                display this help message\n\
   -o, --options             list available options\n\
diff --git a/northd/ovn-northd.8.xml b/northd/ovn-northd.8.xml
index bca9cb4f4e79..b7214b05e7ed 100644
--- a/northd/ovn-northd.8.xml
+++ b/northd/ovn-northd.8.xml
@@ -42,6 +42,16 @@
         as the default.  Otherwise, the default is
         <code>unix:@RUNDIR@/ovnsb_db.sock</code>.
       </dd>
+      <dt><code>--ddlog-record=<var>file</var></code></dt>
+      <dd>
+        This option is for <code>ovn-north-ddlog</code> only.  It causes the
+        daemon to record the initial database state and later changes to
+        <var>file</var> in the text-based DDlog command format.  The
+        <code>ovn_northd_cli</code> program can later replay these changes for
+        debugging purposes.  This option has a performance impact.  See
+        <code>debugging-ddlog.rst</code> in the OVN documentation for more
+        details.
+      </dd>
     </dl>
     <p>
       <var>database</var> in the above options must be an OVSDB active or
-- 
2.31.1