[ovs-dev] Docs: Refer to 18.11.1 dpdk version.
diff mbox series

Message ID 1560340140-26766-1-git-send-email-david.marchand@redhat.com
State Changes Requested
Delegated to: Ian Stokes
Headers show
Series
  • [ovs-dev] Docs: Refer to 18.11.1 dpdk version.
Related show

Commit Message

David Marchand June 12, 2019, 11:49 a.m. UTC
This section is about checking dpdk, we can focus on just its version.
Then update the version to 18.11.1 in the commands output.

Fixes: 03f3f9c0faf8 ("dpdk: Update to use DPDK 18.11.")
Fixes: b5355b0d6e66 ("dpdk: Use DPDK 18.11.1 release.")

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 Documentation/intro/install/dpdk.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

Comments

Ian Stokes June 12, 2019, 12:54 p.m. UTC | #1
On 6/12/2019 12:49 PM, David Marchand wrote:
> This section is about checking dpdk, we can focus on just its version.
> Then update the version to 18.11.1 in the commands output.
> 
> Fixes: 03f3f9c0faf8 ("dpdk: Update to use DPDK 18.11.")
> Fixes: b5355b0d6e66 ("dpdk: Use DPDK 18.11.1 release.")
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
>   Documentation/intro/install/dpdk.rst | 7 +++----
>   1 file changed, 3 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
> index 149548b..e4a95ba 100644
> --- a/Documentation/intro/install/dpdk.rst
> +++ b/Documentation/intro/install/dpdk.rst
> @@ -281,11 +281,10 @@ initialization succeeded::
>   Additionally, the library version linked to ovs-vswitchd can be confirmed
>   with either the ovs-vswitchd logs, or by running either of the commands::
>   
> -  $ ovs-vswitchd --version
> -  ovs-vswitchd (Open vSwitch) 2.9.0
> -  DPDK 17.11.0
> +  $ ovs-vswitchd --version |grep -i dpdk
> +  DPDK 18.11.1
>     $ ovs-vsctl get Open_vSwitch . dpdk_version
> -  "DPDK 17.11.0"
> +  "DPDK 18.11.1"

Hi David,

thanks for this. I had submitted a similar change originally in the v2 
for supporting 18.11 as you have above, but the feedback was to drop the 
change as we could run into a case where on the master branch we support 
a DPDK version that is different to what the latest OVS release supports

https://patchwork.ozlabs.org/patch/1011038/

As this is just an example command, the consensus seemed to be it was ok 
to leave it as is.

The DPDK version wasn't listed before OVS 2.10 release, so an 
alternative approach  could be to tag that this was introduced in OVS 
2.10 using the version changed tag

.. versionchanged:: 2.10.0

and flag above is an example output, users should check the mapping of 
OVS to DPDK using the OVS release faq (that will be kept up to date for 
the latest DPDK release anyhow). Thoughts?

Regards
Ian
David Marchand June 12, 2019, 1:01 p.m. UTC | #2
On Wed, Jun 12, 2019 at 2:55 PM Ian Stokes <ian.stokes@intel.com> wrote:

> On 6/12/2019 12:49 PM, David Marchand wrote:
> > This section is about checking dpdk, we can focus on just its version.
> > Then update the version to 18.11.1 in the commands output.
> >
> > Fixes: 03f3f9c0faf8 ("dpdk: Update to use DPDK 18.11.")
> > Fixes: b5355b0d6e66 ("dpdk: Use DPDK 18.11.1 release.")
> >
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> >   Documentation/intro/install/dpdk.rst | 7 +++----
> >   1 file changed, 3 insertions(+), 4 deletions(-)
> >
> > diff --git a/Documentation/intro/install/dpdk.rst
> b/Documentation/intro/install/dpdk.rst
> > index 149548b..e4a95ba 100644
> > --- a/Documentation/intro/install/dpdk.rst
> > +++ b/Documentation/intro/install/dpdk.rst
> > @@ -281,11 +281,10 @@ initialization succeeded::
> >   Additionally, the library version linked to ovs-vswitchd can be
> confirmed
> >   with either the ovs-vswitchd logs, or by running either of the
> commands::
> >
> > -  $ ovs-vswitchd --version
> > -  ovs-vswitchd (Open vSwitch) 2.9.0
> > -  DPDK 17.11.0
> > +  $ ovs-vswitchd --version |grep -i dpdk
> > +  DPDK 18.11.1
> >     $ ovs-vsctl get Open_vSwitch . dpdk_version
> > -  "DPDK 17.11.0"
> > +  "DPDK 18.11.1"
>
> Hi David,
>
> thanks for this. I had submitted a similar change originally in the v2
> for supporting 18.11 as you have above, but the feedback was to drop the
> change as we could run into a case where on the master branch we support
> a DPDK version that is different to what the latest OVS release supports
>
> https://patchwork.ozlabs.org/patch/1011038/


I had the impression I had already read something but could not find the
mail...
Thanks.


As this is just an example command, the consensus seemed to be it was ok
> to leave it as is.
>
> The DPDK version wasn't listed before OVS 2.10 release, so an
> alternative approach  could be to tag that this was introduced in OVS
> 2.10 using the version changed tag
>
> .. versionchanged:: 2.10.0
>
> and flag above is an example output, users should check the mapping of
> OVS to DPDK using the OVS release faq (that will be kept up to date for
> the latest DPDK release anyhow). Thoughts?
>

In the paragraph before we mention that the user can check ovs-vswitchd
logs without quoting an actual output.
So we might as well remove the example outputs of those two commands.
Ian Stokes June 12, 2019, 1:52 p.m. UTC | #3
On 6/12/2019 2:01 PM, David Marchand wrote:
> 
> 
> On Wed, Jun 12, 2019 at 2:55 PM Ian Stokes <ian.stokes@intel.com 
> <mailto:ian.stokes@intel.com>> wrote:
> 
>     On 6/12/2019 12:49 PM, David Marchand wrote:
>      > This section is about checking dpdk, we can focus on just its
>     version.
>      > Then update the version to 18.11.1 in the commands output.
>      >
>      > Fixes: 03f3f9c0faf8 ("dpdk: Update to use DPDK 18.11.")
>      > Fixes: b5355b0d6e66 ("dpdk: Use DPDK 18.11.1 release.")
>      >
>      > Signed-off-by: David Marchand <david.marchand@redhat.com
>     <mailto:david.marchand@redhat.com>>
>      > ---
>      >   Documentation/intro/install/dpdk.rst | 7 +++----
>      >   1 file changed, 3 insertions(+), 4 deletions(-)
>      >
>      > diff --git a/Documentation/intro/install/dpdk.rst
>     b/Documentation/intro/install/dpdk.rst
>      > index 149548b..e4a95ba 100644
>      > --- a/Documentation/intro/install/dpdk.rst
>      > +++ b/Documentation/intro/install/dpdk.rst
>      > @@ -281,11 +281,10 @@ initialization succeeded::
>      >   Additionally, the library version linked to ovs-vswitchd can be
>     confirmed
>      >   with either the ovs-vswitchd logs, or by running either of the
>     commands::
>      >
>      > -  $ ovs-vswitchd --version
>      > -  ovs-vswitchd (Open vSwitch) 2.9.0
>      > -  DPDK 17.11.0
>      > +  $ ovs-vswitchd --version |grep -i dpdk
>      > +  DPDK 18.11.1
>      >     $ ovs-vsctl get Open_vSwitch . dpdk_version
>      > -  "DPDK 17.11.0"
>      > +  "DPDK 18.11.1"
> 
>     Hi David,
> 
>     thanks for this. I had submitted a similar change originally in the v2
>     for supporting 18.11 as you have above, but the feedback was to drop
>     the
>     change as we could run into a case where on the master branch we
>     support
>     a DPDK version that is different to what the latest OVS release supports
> 
>     https://patchwork.ozlabs.org/patch/1011038/
> 
> 
> I had the impression I had already read something but could not find the 
> mail...
> Thanks.
> 
> 
>     As this is just an example command, the consensus seemed to be it
>     was ok
>     to leave it as is.
> 
>     The DPDK version wasn't listed before OVS 2.10 release, so an
>     alternative approach  could be to tag that this was introduced in OVS
>     2.10 using the version changed tag
> 
>     .. versionchanged:: 2.10.0
> 
>     and flag above is an example output, users should check the mapping of
>     OVS to DPDK using the OVS release faq (that will be kept up to date for
>     the latest DPDK release anyhow). Thoughts?
> 
> 
> In the paragraph before we mention that the user can check ovs-vswitchd 
> logs without quoting an actual output.
> So we might as well remove the example outputs of those two commands.
> 

Agreed, avoids the issue all together, I'd still like to see the version 
change tag just to flag that the commands listed above only output DPDK 
version from OVS 2.10 onward, otherwise someone using 2.9 or prior may 
not be aware the commands do not output DPDK version for those releases.

Ian
> 
> -- 
> David Marchand

Patch
diff mbox series

diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
index 149548b..e4a95ba 100644
--- a/Documentation/intro/install/dpdk.rst
+++ b/Documentation/intro/install/dpdk.rst
@@ -281,11 +281,10 @@  initialization succeeded::
 Additionally, the library version linked to ovs-vswitchd can be confirmed
 with either the ovs-vswitchd logs, or by running either of the commands::
 
-  $ ovs-vswitchd --version
-  ovs-vswitchd (Open vSwitch) 2.9.0
-  DPDK 17.11.0
+  $ ovs-vswitchd --version |grep -i dpdk
+  DPDK 18.11.1
   $ ovs-vsctl get Open_vSwitch . dpdk_version
-  "DPDK 17.11.0"
+  "DPDK 18.11.1"
 
 At this point you can use ovs-vsctl to set up bridges and other Open vSwitch
 features. Seeing as we've configured the DPDK datapath, we will use DPDK-type