This patch set aims to correct errors in ovn-northd documentation.
Specifially, it corrects the following:

* Add missing/incorrect program options to manpages. For this series,
  this includes the ovn-northd, ovn-nb, and ovn-nbctl manpages.
* Correct missing/incorrect program options in usage strings. For this
  series, this includes the ovn-northd and ovn-nbctl programs.

In addition to the above, this series also splits the ovn-northd manpage
in two. The ovn-northd manpage contains only information about running
the ovn-northd application, such as command line options. The new
ovn-logical-flows manpage contains information about the logical flows
that ovn-northd installs. The final commit in this series converts the
ovn-logical-flows manpage input file from XML to rST, since it is more
frequently updated by developers, and rST is much easier to read and
edit than XML.

One thing this series does NOT try to address is missing information in
the ovn-logical-flows document regarding how certain options affect the
generated logical flows. This can be done in another patch series, and
with the conversion to rST, this will likely be much easier to do.

About 99% of this series was AI-generated. My contributions are some
clarifications in the commit messages, as well as updating some
ancillary files in the final commit to indicate the requirement for
rst2man.

Mark Michelson (5):
  ovn-nbctl: Fix documentation and usage output for all commands.
  ovn-nb: Document Load_Balancer "event" option.
  northd: Split logical flow docs into ovn-logical-flows(7).
  northd: Fix ovn-northd manpage and usage for options and commands.
  northd: Convert ovn-logical-flows(7) from XML to RST.

 Documentation/intro/install/general.rst |    5 +
 NEWS                                    |    6 +
 northd/automake.mk                      |    6 +
 northd/ovn-logical-flows.7.rst          | 4311 ++++++++++++++++
 northd/ovn-northd.8.xml                 | 6122 +----------------------
 northd/ovn-northd.c                     |    2 +
 ovn-nb.xml                              |    9 +
 rhel/ovn-fedora.spec.in                 |    1 +
 utilities/ovn-nbctl.8.xml               |  174 +-
 utilities/ovn-nbctl.c                   |  191 +-
 10 files changed, 4661 insertions(+), 6166 deletions(-)
 create mode 100644 northd/ovn-logical-flows.7.rst

-- 
2.52.0

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

Reply via email to