[dpdk-dev] doc: add i40e firmware upgrade guide

Message ID 1502767615-13240-1-git-send-email-qiming.yang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Qiming Yang Aug. 15, 2017, 3:26 a.m. UTC
  This patch adds one link to DPDK i40e doc, which is for
users on how to upgrade firmware.

Signed-off-by: Qiming Yang <qiming.yang@intel.com>
---
 doc/guides/nics/i40e.rst | 2 ++
 1 file changed, 2 insertions(+)
  

Comments

Ferruh Yigit Aug. 15, 2017, 8:52 a.m. UTC | #1
On 8/15/2017 4:26 AM, Qiming Yang wrote:
> This patch adds one link to DPDK i40e doc, which is for
> users on how to upgrade firmware.

Does it make sense to add a link to download the FW too?

> 
> Signed-off-by: Qiming Yang <qiming.yang@intel.com>
> ---
>  doc/guides/nics/i40e.rst | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
> index bc200d3..606375d 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -78,6 +78,8 @@ Prerequisites
>  - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
>    section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
>  
> +- Upgrade the NVM/FW version follow the `Intel® Ethernet NVM Update Tool Quick Usage Guide for Linux
> +  <https://www-ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-linux-usage-guide.html>`_ if need.
>  
>  Pre-Installation Configuration
>  ------------------------------
>
  
Qiming Yang Aug. 16, 2017, 9:12 a.m. UTC | #2
> -----Original Message-----

> From: Yigit, Ferruh

> Sent: Tuesday, August 15, 2017 4:52 PM

> To: Yang, Qiming <qiming.yang@intel.com>; dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei <beilei.xing@intel.com>

> Subject: Re: [dpdk-dev] [PATCH] doc: add i40e firmware upgrade guide

> 

> On 8/15/2017 4:26 AM, Qiming Yang wrote:

> > This patch adds one link to DPDK i40e doc, which is for users on how

> > to upgrade firmware.

> 

> Does it make sense to add a link to download the FW too?

> 

This one is good enough, it has detail about updating process, and in chapter 3.0 includes the link to get the latest NVM.
So it's no need to add another link to download the FW.
> >

> > Signed-off-by: Qiming Yang <qiming.yang@intel.com>

> > ---

> >  doc/guides/nics/i40e.rst | 2 ++

> >  1 file changed, 2 insertions(+)

> >

> > diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index

> > bc200d3..606375d 100644

> > --- a/doc/guides/nics/i40e.rst

> > +++ b/doc/guides/nics/i40e.rst

> > @@ -78,6 +78,8 @@ Prerequisites

> >  - To get better performance on Intel platforms, please follow the "How to get

> best performance with NICs on Intel platforms"

> >    section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.

> >

> > +- Upgrade the NVM/FW version follow the `Intel® Ethernet NVM Update

> > +Tool Quick Usage Guide for Linux

> > +  <https://www-

> ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-

> update-tool-quick-linux-usage-guide.html>`_ if need.

> >

> >  Pre-Installation Configuration

> >  ------------------------------

> >
  
John McNamara Sept. 4, 2017, 4:35 p.m. UTC | #3
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Qiming Yang

> Sent: Tuesday, August 15, 2017 4:27 AM

> To: dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei

> <beilei.xing@intel.com>; Yang, Qiming <qiming.yang@intel.com>

> Subject: [dpdk-dev] [PATCH] doc: add i40e firmware upgrade guide

> 

> This patch adds one link to DPDK i40e doc, which is for users on how to

> upgrade firmware.

> 

> Signed-off-by: Qiming Yang <qiming.yang@intel.com>



> +- Upgrade the NVM/FW version follow the `Intel® Ethernet NVM Update

> +Tool Quick Usage Guide for Linux

> +  <https://www-

> ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-

> tool-quick-linux-usage-guide.html>`_ if need.

> 


Slightly better would be:

s/follow/following/
s/if need/if needed/

But these changes could be make inline during commit so:

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Ferruh Yigit Sept. 5, 2017, 9:41 a.m. UTC | #4
On 9/4/2017 5:35 PM, Mcnamara, John wrote:
> 
> 
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Qiming Yang
>> Sent: Tuesday, August 15, 2017 4:27 AM
>> To: dev@dpdk.org
>> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei
>> <beilei.xing@intel.com>; Yang, Qiming <qiming.yang@intel.com>
>> Subject: [dpdk-dev] [PATCH] doc: add i40e firmware upgrade guide
>>
>> This patch adds one link to DPDK i40e doc, which is for users on how to
>> upgrade firmware.
>>
>> Signed-off-by: Qiming Yang <qiming.yang@intel.com>

> 
> Slightly better would be:
> 
> s/follow/following/
> s/if need/if needed/
> 
> But these changes could be make inline during commit so:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied to dpdk-next-net/master, thanks.

(suggested changes done while applying.)
  

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index bc200d3..606375d 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -78,6 +78,8 @@  Prerequisites
 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
   section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
 
+- Upgrade the NVM/FW version follow the `Intel® Ethernet NVM Update Tool Quick Usage Guide for Linux
+  <https://www-ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-linux-usage-guide.html>`_ if need.
 
 Pre-Installation Configuration
 ------------------------------