Fix grammar issues: duplicate "if" in general.rst, "a upgrade" to "an upgrade" in ovn-upgrades.rst.
Fix typos: "dont" to "don't" (two occurrences), "reasonble" to "reasonable". Fix formatting: add missing space after dollar sign prompts in the example usage section, add blank line before code block, break long configure line. Update OVS documentation URL from http to https. Assisted-by: Claude Opus 4.6, OpenCode Signed-off-by: Ales Musil <[email protected]> --- Documentation/intro/install/general.rst | 26 +++++++++++--------- Documentation/intro/install/ovn-upgrades.rst | 18 +++++++------- 2 files changed, 23 insertions(+), 21 deletions(-) diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst index e622e044c..890943b70 100644 --- a/Documentation/intro/install/general.rst +++ b/Documentation/intro/install/general.rst @@ -39,7 +39,7 @@ repository, which you can clone into a directory named "ovn" with:: Cloning the repository leaves the "main" branch initially checked out. This is the right branch for general development. -If, on the other hand, if you want to build a particular released +If you want to build a particular released version, you can check it out by running a command such as the following from the "ovn" directory:: @@ -291,17 +291,19 @@ to LIBS:: $ ./configure LIBS=-ljemalloc Example usage:: + $ # Clone OVS repo - $cd /home/foo/ovs - $./boot.sh - $mkdir _gcc - $cd _gcc && ../configure && cd .. - $make -C _gcc + $ cd /home/foo/ovs + $ ./boot.sh + $ mkdir _gcc + $ cd _gcc && ../configure && cd .. + $ make -C _gcc $ # Clone OVN repo - $cd /home/foo/ovn - $./boot.sh - $./configure --with-ovs-source=/home/foo/ovs/ --with-ovs-build=/home/foo/ovs/_gcc + $ cd /home/foo/ovn + $ ./boot.sh + $ ./configure --with-ovs-source=/home/foo/ovs/ \ + --with-ovs-build=/home/foo/ovs/_gcc It is expected to configure both Open vSwitch and OVN with the same prefix. @@ -421,7 +423,7 @@ Unix domain socket:: Starting OVN Central services in containers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For OVN central node, we dont need to load ovs kernel modules on host. +For OVN central node, we don't need to load ovs kernel modules on host. Hence, OVN central containers OS need not depend on host OS. Also we can leverage deploying entire OVN control plane in a pod spec for use @@ -544,7 +546,7 @@ domain socket:: Starting OVN host service in containers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For OVN host too, we dont need to load ovs kernel modules on host. +For OVN host too, we don't need to load ovs kernel modules on host. Hence, OVN host container OS need not depend on host OS. Also we can leverage deploying OVN host in a pod spec for use cases like @@ -552,7 +554,7 @@ OVN-kubernetes to manage OVS which can be running as a service on host or in container. Start ovsdb-server and ovs-vswitchd components as per -http://docs.openvswitch.org/en/latest/intro/install/general/ +https://docs.openvswitch.org/en/latest/intro/install/general/ start local ovn-controller with below command if ovs is also running in container:: diff --git a/Documentation/intro/install/ovn-upgrades.rst b/Documentation/intro/install/ovn-upgrades.rst index f80fa09d0..c6bcfc764 100644 --- a/Documentation/intro/install/ovn-upgrades.rst +++ b/Documentation/intro/install/ovn-upgrades.rst @@ -119,7 +119,7 @@ a version mismatch between the ovn-controller and ovn-northd is detected. Steps ----- -This section documents individual steps in a upgrade procedure in no particular +This section documents individual steps in an upgrade procedure in no particular order. For information on ordering of the steps, please refer to the `Upgrade procedures`_ section. @@ -176,14 +176,14 @@ During database upgrading, if there is schema change, the DB file will be converted to the new schema automatically, if the schema change is backward compatible. OVN tries the best to keep the DB schemas backward compatible. -However, there can be situations that an incompatible change is reasonble. An -example of such case is to add constraints in the table to ensure correctness. -If there were already data that violates the new constraints got added somehow, -it will result in DB upgrade failures. In this case, user should manually -correct data using ovn-nbctl (for north-bound DB) or ovn-sbctl (for south- -bound DB), and then upgrade again following previous steps. Below is a list -of known incompatible schema changes and how to fix when error -encountered. +However, there can be situations that an incompatible change is reasonable. +An example of such case is to add constraints in the table to ensure +correctness. If there were already data that violates the new constraints +got added somehow, it will result in DB upgrade failures. In this case, +user should manually correct data using ovn-nbctl (for north-bound DB) or +ovn-sbctl (for south-bound DB), and then upgrade again following previous +steps. Below is a list of known incompatible schema changes and how to +fix when error encountered. Post-split releases (20.03+) '''''''''''''''''''''''''''' -- 2.54.0 _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
