Three command line options where left out of documentation,
--leader-only, --no-leader-only and --unixctl. This patch updates the
documentation to include the flags.
Fixes: 486e7bebc415 ("ovn-trace: Support connecting to SB raft followers.")
Fixes: 4735d397a400 ("ovn-trace: New utility.")
Reported-at: https://redhat.atlassian.net/browse/FDP-4279
Assisted-by: Qwen3.8-27B-FP8, OpenCode
Signed-off-by: Jacob Tanenbaum <[email protected]>
---
utilities/ovn-trace.8.xml | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/utilities/ovn-trace.8.xml b/utilities/ovn-trace.8.xml
index 80dd97138..97e595bae 100644
--- a/utilities/ovn-trace.8.xml
+++ b/utilities/ovn-trace.8.xml
@@ -489,6 +489,31 @@
default is unlikely to be useful outside of single-machine OVN test
environments.
</dd>
+
+ <dt><code>--leader-only</code></dt>
+ <dt><code>--no-leader-only</code></dt>
+ <dd>
+ By default, or with <code>--leader-only</code>, when the database
+ server is a clustered database, <code>ovn-trace</code> reads only
+ from the cluster leader. This ensures that the data
+ <code>ovn-trace</code> reads is up-to-date. With
+ <code>--no-leader-only</code>, <code>ovn-trace</code> uses any
+ server in the cluster, which means that it can read stale data.
+ Refer to <code>Understanding Cluster Consistency</code> in
+ <code>ovsdb</code>(7) for more information.
+ </dd>
+
+ <dt><code>--unixctl=</code><var>socket</var></dt>
+ <dd>
+ Sets the name of the control socket on which <code>ovn-trace</code>
+ listens for runtime management commands when run in daemon mode with
+ <code>--detach</code>. If <var>socket</var> does not begin with
+ <code>/</code>, it is interpreted as relative to
+ <code>@RUNDIR@</code>. If <code>--unixctl</code> is not specified,
+ the default socket is
+ <code>@RUNDIR@/ovn-trace.</code><var>pid</var><code>.ctl</code>,
+ where <var>pid</var> is <code>ovn-trace</code>'s process ID.
+ </dd>
</dl>
<xi:include href="lib/common.xml"
xmlns:xi="http://www.w3.org/2003/XInclude"/>
--
2.55.0
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
