[v2,02/15] doc: update nfp documentation

Message ID 20220616023939.1798769-3-jin.liu@corigine.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series Add support of NFP3800 chip and firmware with NFDk |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Jin Liu June 16, 2022, 2:39 a.m. UTC
  This set patches add support for a new type of NFP nic NFP3800 and
the firmware with NFDk.

Signed-off-by: Jin Liu <jin.liu@corigine.com>
Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
---
 doc/guides/nics/nfp.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
  

Comments

Ferruh Yigit June 16, 2022, 3:04 p.m. UTC | #1
On 6/16/2022 3:39 AM, Jin Liu wrote:
> This set patches add support for a new type of NFP nic NFP3800 and
> the firmware with NFDk.
> 
> Signed-off-by: Jin Liu <jin.liu@corigine.com>
> Signed-off-by: Chaoyong He <chaoyong.he@corigine.com>
> Signed-off-by: Niklas Söderlund <niklas.soderlund@corigine.com>
> ---
>   doc/guides/nics/nfp.rst | 10 ++++++----
>   1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
> index 30cdc69202..2d2b6d283a 100644
> --- a/doc/guides/nics/nfp.rst
> +++ b/doc/guides/nics/nfp.rst
> @@ -12,7 +12,8 @@ up to 400-Gb/s.
>   
>   This document explains how to use DPDK with the Netronome Poll Mode
>   Driver (PMD) supporting Netronome's Network Flow Processor 6xxx
> -(NFP-6xxx) and Netronome's Flow Processor 4xxx (NFP-4xxx).
> +(NFP-6xxx) and Netronome's Flow Processor 4xxx (NFP-4xxx) or
> +Netronome's Flow Processor 38xx (NFP-38xx).
>   

It is clearer to update working as "supporting X, Y and Z"

Again please squash the patch to the relevant commit, instead of having 
a separate doc patch.

>   NFP is a SRIOV capable device and the PMD supports the physical
>   function (PF) and the virtual functions (VFs).
> @@ -99,9 +100,10 @@ more than one SmartNIC, same type of SmartNIC or different ones, and to upload a
>   different firmware to each SmartNIC.
>   
>      .. Note::
> -      Currently the NFP PMD supports using the PF with Agilio Basic Firmware. See
> -      https://help.netronome.com/support/solutions for more information on the
> -      various firmwares supported by the Netronome Agilio CX smartNIC.
> +      Currently the NFP PMD supports using the PF with Agilio Firmware with NFD3
> +      and Agilio Firmware with NFDk. See https://help.netronome.com/support/solutions
> +      for more information on the various firmwares supported by the Netronome
> +      Agilio CX smartNIC.
>   
>   PF multiport support
>   --------------------
  

Patch

diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
index 30cdc69202..2d2b6d283a 100644
--- a/doc/guides/nics/nfp.rst
+++ b/doc/guides/nics/nfp.rst
@@ -12,7 +12,8 @@  up to 400-Gb/s.
 
 This document explains how to use DPDK with the Netronome Poll Mode
 Driver (PMD) supporting Netronome's Network Flow Processor 6xxx
-(NFP-6xxx) and Netronome's Flow Processor 4xxx (NFP-4xxx).
+(NFP-6xxx) and Netronome's Flow Processor 4xxx (NFP-4xxx) or
+Netronome's Flow Processor 38xx (NFP-38xx).
 
 NFP is a SRIOV capable device and the PMD supports the physical
 function (PF) and the virtual functions (VFs).
@@ -99,9 +100,10 @@  more than one SmartNIC, same type of SmartNIC or different ones, and to upload a
 different firmware to each SmartNIC.
 
    .. Note::
-      Currently the NFP PMD supports using the PF with Agilio Basic Firmware. See
-      https://help.netronome.com/support/solutions for more information on the
-      various firmwares supported by the Netronome Agilio CX smartNIC.
+      Currently the NFP PMD supports using the PF with Agilio Firmware with NFD3
+      and Agilio Firmware with NFDk. See https://help.netronome.com/support/solutions
+      for more information on the various firmwares supported by the Netronome
+      Agilio CX smartNIC.
 
 PF multiport support
 --------------------