In depth review of ovn-sbctl documentation. Bringing the documentation
up to date and reviewing for grammer.

Reported-at: https://redhat.atlassian.net/browse/FDP-4278
Assisted-by: Claude Opus 4.6, Claude Code
Signed-off-by: Jacob Tanenbaum <[email protected]>

---
    -v3
        ovn-sbctl: Wrap heading description in xml tags.
            * Shortened commit title
        ovn-sbctl: Remove troff markup.
            * merged with another patch that did the same thing
        ovn-sbctl: Missing comma in chassis-del.
            * needed to move my change log to under the Signed-of line
        ovn-sbctl: Correct command description.
            * incorrect command in the commit description
              lflow-list->count-lflows
        ovn-sbctl: Replace <code> tags for <ref> tags.
            * changed incorrectly labeled table SB_Global->Connection
    -v2
        ovn-sbctl: Missing comma in chassis-del.
            * description of commit incorrectly said command was
              "--may-exist"
        ovn-sbctl: Correct command description.
            * incorrect capitalization in commit message THe -> The
        ovn-sbctl: Remove troff markup.
            * Spelling error in patch subject Reomve -> Remove
        ovn-sbctl: Command ip-multicast-flush undocumented.
            * correct indentation to be the same as the rest of the document
        ovn-sbctl: Correct description of chassis-del.
            * added a missed period to the end of a sentance
        ovn-sbctl: dump-flows defined as alias
            * simplify dump-flows to mention it is just an alias.
            * add a reference to lflow-list in dump-flows description
        ovn-sbctl: Correct what is included for --vflows.
            * Corrected where/were in commit message
            * changed the wording of "The --ovs and --stats can also be used
              in conjunction with --vflows" -> "The --ovs and --stats  options
              can also be used in conjunction with --vflows."
        ovn-sbctl: Document modifiers for set-connection.
            * simplified commit message
        ovn-sbctl: Document changing inactivity probe.
            * changed from using <code> blocks to <ref> blocks for SB_Global
               and the SB_Global options column
        ovn-sbctl: Replace <code> tags for <ref> tags.
            * created


*** BLURB HERE ***

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.
  ovn-sbctl: Correct heading capitalization.
  ovn-sbctl: Wrap heading description in xml tags.
  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: 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 defined as alias
  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.
  ovn-sbctl: Replace <code> tags for <ref> tags.

 utilities/ovn-sbctl.8.xml | 143 ++++++++++++++++++++++++++++----------
 utilities/ovn-sbctl.c     |   9 ++-
 2 files changed, 115 insertions(+), 37 deletions(-)

-- 
2.55.0

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to