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 penultimate 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. In order to make use of infrastructure already in place for rST manpages, the file is moved to the Documentation/ref directory. This also results in our creating an HTML page from the rST file when building OVN. The final commit attempts to put into place some cross-references between sections based on existing language in the document. There may be places we could add further cross-references, but this takes care of what currently exists in the document. 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 a couple of small edits. Mark Michelson (6): 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. northd: Add cross-references and reflow ovn-logical-flows(7). Documentation/automake.mk | 2 +- Documentation/conf.py | 2 + Documentation/intro/install/general.rst | 5 + Documentation/ref/index.rst | 1 + Documentation/ref/ovn-logical-flows.7.rst | 3855 +++++++++++++ NEWS | 6 + northd/ovn-northd.8.xml | 6122 +-------------------- northd/ovn-northd.c | 2 + ovn-nb.xml | 9 + utilities/ovn-nbctl.8.xml | 174 +- utilities/ovn-nbctl.c | 191 +- 11 files changed, 4202 insertions(+), 6167 deletions(-) create mode 100644 Documentation/ref/ovn-logical-flows.7.rst -- 2.52.0 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
