Hi Jacob, thanks for the patches.
I have notes on individual patches, see those for more information.
I also asked claude code to determine if, after these updates, there
were any missing/inconsistent documentation, and it came back with the
following:
* The set-ssl command help text uses different nomenclature from the
XML. The help text uses "SSL-PROTOS" and "SSL-CIPHERS" but the XML
uses "ssl-protocol-list" and "ssl-cipher-list".
* The sbctl_usage() string is missing the following:
* init: Command missing entirely
* show: --filter=
* chassis-add: --may-exist
* chassis-del: --if-exists
* lsp-bind: --may-exist
* lsp-unbind: --if-exists
* lflow-list: --uuid, --ovs, --stats, --vflows
* dump-flows: --uuid, --ovs, --stats, --vflows
* set-ssl: --bootstrap
* While the global "--no-leader-only" option is documented in the help
text, "--leader-only", "--shuffle-remotes", and "--no-shuffle-remotes"
are not.
I also have one additional note with regards to the cover letter
itself. See below.
On Tue, Sep 1, 2026 at 11:57 AM Jacob Tanenbaum via dev
<[email protected]> wrote:
>
>
> In depth review of ovn-sbctl documentation. Bringing the documentation
s/. Bringing/, bringing/
> up to date and reviewing for grammer
s/grammer/grammar./
I normally wouldn't care about this sort of thing on a cover letter,
but since the series deals with documentation and editing, it makes
sense to get the cover letter correct, too :)
>
> Reported-at: https://redhat.atlassian.net/browse/FDP-4278
> Assisted-by: Claude Opus 4.6, Claude Code
>
> Jacob Tanenbaum (20):
> ovn-sbctl: Fix typo exmple->example.
> ovn-sbctl: Duplicate "the" in ovn-sbctl.8.xml.
> ovn-sbctl: Missing indefinite article.
> ovn-sbctl: Remove troff markup in ovn-sbctl.8.xml.
> ovn-sbctl: Correct heading capitalization.
> ovn-sbctl: Add xml tags around heading description.
> ovn-sbctl: Correct <var> tag to <code> tag.
> ovn-sbctl: Missing comma in chassis-del.
> ovn-sbctl: Missing indefinite article in lsp-unbind.
> ovn-sbctl: Correct command description.
> ovn-sbctl: Reomve troff markup.
> ovn-sbctl: Correct the description for set-connection.
> ovn-sbctl: Command ip-multicast-flush undocumented.
> ovn-sbctl: Correct description of chassis-del.
> ovn-sbctl: Add what chassis-del removes to docs.
> ovn-sbctl: dump-flows and lflow-list should have the same options.
> ovn-sbctl: Correct what is included for --vflows.
> ovn-sbctl: Correct lsp-bind --may-exist description.
> ovn-sbctl: Document modifiers for set-connection.
> ovn-sbctl: Document changing inactivity probe.
>
> utilities/ovn-sbctl.8.xml | 125 +++++++++++++++++++++++++++++---------
> utilities/ovn-sbctl.c | 9 ++-
> 2 files changed, 104 insertions(+), 30 deletions(-)
>
> --
> 2.55.0
>
> _______________________________________________
> dev mailing list
> [email protected]
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
