From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Xu, Qian Q" <qian.q.xu@intel.com>, "dev@dpdk.org" <dev@dpdk.org>
Cc: "Xu, Qian Q" <qian.q.xu@intel.com>
Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
Date: Fri, 8 Apr 2016 10:02:21 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE20250E0B7@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1460105823-2013-1-git-send-email-qian.q.xu@intel.com>
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
prev parent reply other threads:[~2016-04-08 10:02 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-04-08 8:57 Qian Xu
2016-04-08 9:05 ` Thomas Monjalon
2016-04-08 10:04 ` Mcnamara, John
2016-04-08 14:29 ` Xu, Qian Q
2016-04-08 14:47 ` Thomas Monjalon
2016-04-08 10:02 ` Mcnamara, John [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B27915DBBA3421428155699D51E4CFE20250E0B7@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=qian.q.xu@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).