| Message ID | 20240313163953.44882-1-martin.kalcok@canonical.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [ovs-dev] docs: Remove ref. to "ovn-sbctl --no-wait". | expand |
| Context | Check | Description |
|---|---|---|
| ovsrobot/apply-robot | success | apply and check: success |
| ovsrobot/github-robot-_ovn-kubernetes | success | github build: passed |
| ovsrobot/github-robot-_Build_and_Test | fail | github build: failed |
On Wed, Mar 13, 2024 at 5:40 PM Martin Kalcok <martin.kalcok@canonical.com> wrote: > Couple places in the documentation reference "--wait" and "--no-wait" > options for "ovn-sbctl" but it doesn't support these options [0]. > > Trying, for example, "ovn-sbctl --no-wait init" exits with: > > ovn-sbctl: --no-wait not supported > > [0] > https://github.com/ovn-org/ovn/blob/63b35e2f6789f7843363c8f7a92430402bf989f9/utilities/ovn-sbctl.c#L127 > > Signed-off-by: Martin Kalcok <martin.kalcok@canonical.com> > --- > Documentation/intro/install/general.rst | 2 +- > utilities/ovn-sbctl.8.xml | 8 ++++---- > 2 files changed, 5 insertions(+), 5 deletions(-) > > diff --git a/Documentation/intro/install/general.rst > b/Documentation/intro/install/general.rst > index ab6209482..6efb3a701 100644 > --- a/Documentation/intro/install/general.rst > +++ b/Documentation/intro/install/general.rst > @@ -428,7 +428,7 @@ the first time after you create the databases with > ovsdb-tool, though running > it at any time is harmless:: > > $ ovn-nbctl --no-wait init > - $ ovn-sbctl --no-wait init > + $ ovn-sbctl init > > Start ``ovn-northd``, telling it to connect to the OVN db servers same > Unix domain socket:: > diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml > index 81ab4131d..32035d051 100644 > --- a/utilities/ovn-sbctl.8.xml > +++ b/utilities/ovn-sbctl.8.xml > @@ -123,10 +123,10 @@ > <dd> > Instructs the daemon process to run one or more > <code>ovn-sbctl</code> > commands described above and reply with the results of running > these > - commands. Accepts the <code>--no-wait</code>, <code>--wait</code>, > - <code>--timeout</code>, <code>--dry-run</code>, > <code>--oneline</code>, > - and the options described under <code>Table Formatting > Options</code> > - in addition to the the command-specific options. > + commands. Accepts the <code>--timeout</code>, > <code>--dry-run</code>, > + <code>--oneline</code>, and the options described under > + <code>Table Formatting Options</code> in addition to the the > + command-specific options. > </dd> > > <dt><code>exit</code></dt> > -- > 2.40.1 > > _______________________________________________ > dev mailing list > dev@openvswitch.org > https://mail.openvswitch.org/mailman/listinfo/ovs-dev > > Looks good to me, thanks. Acked-by: Ales Musil <amusil@redhat.com>
On 3/20/24 06:23, Ales Musil wrote: > On Wed, Mar 13, 2024 at 5:40 PM Martin Kalcok <martin.kalcok@canonical.com> > wrote: > >> Couple places in the documentation reference "--wait" and "--no-wait" >> options for "ovn-sbctl" but it doesn't support these options [0]. >> >> Trying, for example, "ovn-sbctl --no-wait init" exits with: >> >> ovn-sbctl: --no-wait not supported >> >> [0] >> https://github.com/ovn-org/ovn/blob/63b35e2f6789f7843363c8f7a92430402bf989f9/utilities/ovn-sbctl.c#L127 >> >> Signed-off-by: Martin Kalcok <martin.kalcok@canonical.com> >> --- >> Documentation/intro/install/general.rst | 2 +- >> utilities/ovn-sbctl.8.xml | 8 ++++---- >> 2 files changed, 5 insertions(+), 5 deletions(-) >> >> diff --git a/Documentation/intro/install/general.rst >> b/Documentation/intro/install/general.rst >> index ab6209482..6efb3a701 100644 >> --- a/Documentation/intro/install/general.rst >> +++ b/Documentation/intro/install/general.rst >> @@ -428,7 +428,7 @@ the first time after you create the databases with >> ovsdb-tool, though running >> it at any time is harmless:: >> >> $ ovn-nbctl --no-wait init >> - $ ovn-sbctl --no-wait init >> + $ ovn-sbctl init >> >> Start ``ovn-northd``, telling it to connect to the OVN db servers same >> Unix domain socket:: >> diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml >> index 81ab4131d..32035d051 100644 >> --- a/utilities/ovn-sbctl.8.xml >> +++ b/utilities/ovn-sbctl.8.xml >> @@ -123,10 +123,10 @@ >> <dd> >> Instructs the daemon process to run one or more >> <code>ovn-sbctl</code> >> commands described above and reply with the results of running >> these >> - commands. Accepts the <code>--no-wait</code>, <code>--wait</code>, >> - <code>--timeout</code>, <code>--dry-run</code>, >> <code>--oneline</code>, >> - and the options described under <code>Table Formatting >> Options</code> >> - in addition to the the command-specific options. >> + commands. Accepts the <code>--timeout</code>, >> <code>--dry-run</code>, >> + <code>--oneline</code>, and the options described under >> + <code>Table Formatting Options</code> in addition to the the >> + command-specific options. >> </dd> >> >> <dt><code>exit</code></dt> >> -- >> 2.40.1 >> >> _______________________________________________ >> dev mailing list >> dev@openvswitch.org >> https://mail.openvswitch.org/mailman/listinfo/ovs-dev >> >> > Looks good to me, thanks. > > Acked-by: Ales Musil <amusil@redhat.com> > Thanks Martin and Ales. I merged this to main and all branches back to 23.06.
diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst index ab6209482..6efb3a701 100644 --- a/Documentation/intro/install/general.rst +++ b/Documentation/intro/install/general.rst @@ -428,7 +428,7 @@ the first time after you create the databases with ovsdb-tool, though running it at any time is harmless:: $ ovn-nbctl --no-wait init - $ ovn-sbctl --no-wait init + $ ovn-sbctl init Start ``ovn-northd``, telling it to connect to the OVN db servers same Unix domain socket:: diff --git a/utilities/ovn-sbctl.8.xml b/utilities/ovn-sbctl.8.xml index 81ab4131d..32035d051 100644 --- a/utilities/ovn-sbctl.8.xml +++ b/utilities/ovn-sbctl.8.xml @@ -123,10 +123,10 @@ <dd> Instructs the daemon process to run one or more <code>ovn-sbctl</code> commands described above and reply with the results of running these - commands. Accepts the <code>--no-wait</code>, <code>--wait</code>, - <code>--timeout</code>, <code>--dry-run</code>, <code>--oneline</code>, - and the options described under <code>Table Formatting Options</code> - in addition to the the command-specific options. + commands. Accepts the <code>--timeout</code>, <code>--dry-run</code>, + <code>--oneline</code>, and the options described under + <code>Table Formatting Options</code> in addition to the the + command-specific options. </dd> <dt><code>exit</code></dt>
Couple places in the documentation reference "--wait" and "--no-wait" options for "ovn-sbctl" but it doesn't support these options [0]. Trying, for example, "ovn-sbctl --no-wait init" exits with: ovn-sbctl: --no-wait not supported [0] https://github.com/ovn-org/ovn/blob/63b35e2f6789f7843363c8f7a92430402bf989f9/utilities/ovn-sbctl.c#L127 Signed-off-by: Martin Kalcok <martin.kalcok@canonical.com> --- Documentation/intro/install/general.rst | 2 +- utilities/ovn-sbctl.8.xml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-)