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

[Mcnamara, John]

Hi,

Thanks for that, some comments below.

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Qian Xu
> Sent: Friday, April 8, 2016 9:57 AM
> To: dev at dpdk.org
> Cc: Xu, Qian Q <qian.q.xu at 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 at 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