[dpdk-dev,v1] doc:add tested platforms and nics

  add a new file about tested platforms and nics in doc/guides/nics
Signed-off-by: Qian Xu <qian.q.xu@intel.com>
  

2016-04-08 16:57, Qian Xu:
> add a new file about tested platforms and nics in doc/guides/nics
> Signed-off-by: Qian Xu <qian.q.xu@intel.com>
> 
> diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
> index 769f677..d34040b 100644
> --- a/doc/guides/nics/index.rst
> +++ b/doc/guides/nics/index.rst
> @@ -36,6 +36,7 @@ Network Interface Controller Drivers
>      :numbered:
>  
>      overview
> +    test_platforms

I think it would be better suited to integrate this information
in the existing pages for e1000, ixgbe, i40e and fm10k.
  

Hi,

Thanks for that, some comments below.

> -----Original Message-----

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

> Sent: Friday, April 8, 2016 9:57 AM

> To: dev@dpdk.org

> Cc: Xu, Qian Q <qian.q.xu@intel.com>

> Subject: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

> 

> add a new file about tested platforms and nics in doc/guides/nics

> Signed-off-by: Qian Xu <qian.q.xu@intel.com>

> 

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

> 769f677..d34040b 100644

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

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

> @@ -36,6 +36,7 @@ Network Interface Controller Drivers

>      :numbered:

> 

>      overview

> +    test_platforms

>      bnx2x

>      cxgbe

>      e1000em


I would suggest adding this as the last chapter in the NICs guide.



> +

> +Tested Platforms

> +----------------

> +

> +Platform#1: SuperMicro 1U

> +


Instead of using "Platform#1" I would suggest omitting "Platform" and just use a simple numbered list using the RST directive "#." like this:

#. SuperMicro 1U



> +- BIOS: 1.0c

> +- Processor: Intel(R) Atom(TM) CPU  C2758  @ 2.40GHz


Some parts of the doc use (R) and (TM) and some use the symbols. I suggest using one or the other in all places.



> +

> +Platform#2: SuperMicro 1U

> +

> +- BIOS: 1.0a

> +- Processor: Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz

> +- Onboard NIC: Intel(R) X552/X557-AT(2x10G)

> +  - firmware-version: 0x800001cf;

> +  - device ID(PF/VF): 8086:15ad /8086:15a8;

> +  - kernel driver version: 4.2.5(ixgbe)


Apart from (R) and (TM) there should be a space between before all other parentheses, like this: 4.2.5 (ixgbe).

This is in several places in the docs.



> +Tested NICs

> +-----------

> +

> +NIC#1: Intel® Ethernet Controller X540-AT2


Same comment about using a numbered list as above.


Also, there are several checkpatch warnings about trailing whitespace and some tabs that should be fixed.

Thanks,

John
  

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, April 8, 2016 10:06 AM
> To: Xu, Qian Q <qian.q.xu@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> >      overview
> > +    test_platforms
> 
> I think it would be better suited to integrate this information in the
> existing pages for e1000, ixgbe, i40e and fm10k.

Hi,

I think that this is better in one section where it can be reviewed together. I think it should be the last chapter in the section though.

John.
--
  

Agreed, and others can add their NICs info into the tested NICs and platforms. One question about the release version, the NICs and platforms may change with the release version, for example, for each release, the information may be different, so we need mention the release version for the tested nics and platforms. Then how about putting them in one session of release notes? 

Thanks
Qian


-----Original Message-----
From: Mcnamara, John 
Sent: Friday, April 08, 2016 6:05 PM
To: Thomas Monjalon; Xu, Qian Q
Cc: dev@dpdk.org
Subject: RE: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, April 8, 2016 10:06 AM
> To: Xu, Qian Q <qian.q.xu@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> >      overview
> > +    test_platforms
> 
> I think it would be better suited to integrate this information in the 
> existing pages for e1000, ixgbe, i40e and fm10k.

Hi,

I think that this is better in one section where it can be reviewed together. I think it should be the last chapter in the section though.

John.
--
  

2016-04-08 14:29, Xu, Qian Q:
> Agreed, and others can add their NICs info into the tested NICs and platforms. One question about the release version, the NICs and platforms may change with the release version, for example, for each release, the information may be different, so we need mention the release version for the tested nics and platforms. Then how about putting them in one session of release notes? 

Please do at your convenience but do it quickly.
Thanks


> -----Original Message-----
> From: Mcnamara, John 
> Sent: Friday, April 08, 2016 6:05 PM
> To: Thomas Monjalon; Xu, Qian Q
> Cc: dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > Sent: Friday, April 8, 2016 10:06 AM
> > To: Xu, Qian Q <qian.q.xu@intel.com>
> > Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> > Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> > 
> > >      overview
> > > +    test_platforms
> > 
> > I think it would be better suited to integrate this information in the 
> > existing pages for e1000, ixgbe, i40e and fm10k.
> 
> Hi,
> 
> I think that this is better in one section where it can be reviewed together. I think it should be the last chapter in the section though.
> 
> John.
>