| Message ID | 20210728131941.3649-3-cian.ferriter@intel.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [ovs-dev,1/3] dpif-netdev-unixctl.man: Document subtable-lookup-* CMDs | expand |
| Context | Check | Description |
|---|---|---|
| ovsrobot/apply-robot | success | apply and check: success |
| ovsrobot/github-robot | success | github build: passed |
> The "name" parameter isn't optional so don't use brackets around it. > Thanks for the patch Cian, comment below. > Fixes: 5c5c98cec21b ("docs/dpdk/bridge: Add miniflow extract section.") > Signed-off-by: Cian Ferriter <cian.ferriter@intel.com> > --- > Documentation/topics/dpdk/bridge.rst | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/topics/dpdk/bridge.rst > b/Documentation/topics/dpdk/bridge.rst > index f422eb5e9..1aa41958c 100644 > --- a/Documentation/topics/dpdk/bridge.rst > +++ b/Documentation/topics/dpdk/bridge.rst > @@ -318,8 +318,8 @@ command also shows whether the CPU supports each > implementation :: > > An implementation can be selected manually by the following command :: > > - $ ovs-appctl dpif-netdev/miniflow-parser-set [-pmd core_id] [name] > - [study_cnt] > + $ ovs-appctl dpif-netdev/miniflow-parser-set [-pmd core_id] name \ > + [study_cnt] I would keep [study_cnt] aligned under ovs-appctl above, currently seems to be extra white space before it. BR Ian > > The above command has two optional parameters: study_cnt and core_id. > The core_id sets a particular miniflow extract function to a specific > -- > 2.32.0 > > _______________________________________________ > dev mailing list > dev@openvswitch.org > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> -----Original Message----- > From: Stokes, Ian <ian.stokes@intel.com> > Sent: Thursday 12 August 2021 15:58 > To: Ferriter, Cian <cian.ferriter@intel.com>; ovs-dev@openvswitch.org > Cc: fbl@sysclose.org > Subject: RE: [ovs-dev] [PATCH 3/3] docs/dpdk/bridge: Fix dpif-netdev/miniflow-parser-set formatting > > > The "name" parameter isn't optional so don't use brackets around it. > > > > Thanks for the patch Cian, comment below. > > > Fixes: 5c5c98cec21b ("docs/dpdk/bridge: Add miniflow extract section.") > > Signed-off-by: Cian Ferriter <cian.ferriter@intel.com> > > --- > > Documentation/topics/dpdk/bridge.rst | 4 ++-- > > 1 file changed, 2 insertions(+), 2 deletions(-) > > > > diff --git a/Documentation/topics/dpdk/bridge.rst > > b/Documentation/topics/dpdk/bridge.rst > > index f422eb5e9..1aa41958c 100644 > > --- a/Documentation/topics/dpdk/bridge.rst > > +++ b/Documentation/topics/dpdk/bridge.rst > > @@ -318,8 +318,8 @@ command also shows whether the CPU supports each > > implementation :: > > > > An implementation can be selected manually by the following command :: > > > > - $ ovs-appctl dpif-netdev/miniflow-parser-set [-pmd core_id] [name] > > - [study_cnt] > > + $ ovs-appctl dpif-netdev/miniflow-parser-set [-pmd core_id] name \ > > + [study_cnt] > > I would keep [study_cnt] aligned under ovs-appctl above, currently seems to be extra white space > before it. > The white space before [study_cnt] was intentional. I was following the convention for wrapping shell commands shown in Documentation/howto/dpdk.rst: https://github.com/openvswitch/ovs/blob/master/Documentation/howto/dpdk.rst#ports-and-bridges You are right though, the convention in Documentation/topics/dpdk/bridge.rst is not to indent after wrapping the shall command. I'm fine with either way, so I'll align under ovs-appctl in the next version. > BR > Ian > > > > The above command has two optional parameters: study_cnt and core_id. > > The core_id sets a particular miniflow extract function to a specific > > -- > > 2.32.0 > > > > _______________________________________________ > > dev mailing list > > dev@openvswitch.org > > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
diff --git a/Documentation/topics/dpdk/bridge.rst b/Documentation/topics/dpdk/bridge.rst index f422eb5e9..1aa41958c 100644 --- a/Documentation/topics/dpdk/bridge.rst +++ b/Documentation/topics/dpdk/bridge.rst @@ -318,8 +318,8 @@ command also shows whether the CPU supports each implementation :: An implementation can be selected manually by the following command :: - $ ovs-appctl dpif-netdev/miniflow-parser-set [-pmd core_id] [name] - [study_cnt] + $ ovs-appctl dpif-netdev/miniflow-parser-set [-pmd core_id] name \ + [study_cnt] The above command has two optional parameters: study_cnt and core_id. The core_id sets a particular miniflow extract function to a specific
The "name" parameter isn't optional so don't use brackets around it. Fixes: 5c5c98cec21b ("docs/dpdk/bridge: Add miniflow extract section.") Signed-off-by: Cian Ferriter <cian.ferriter@intel.com> --- Documentation/topics/dpdk/bridge.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)