[dpdk-dev] [PATCH] doc: add doc for i40e pmd driver introduction

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Jingjing Wu
> Sent: Thursday, January 28, 2016 8:51 AM
> To: dev at dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: add doc for i40e pmd driver introduction
> 
> A new doc "i40e.rst" is added to introduce i40e pmd driver.
> 
> Signed-off-by: Jingjing Wu <jingjing.wu at intel.com>


Thanks for the new doc. Some minor comments below.

> +
> +- Multiple queues for TX and RX
> +- Receiver Side Steering (RSS)

s/Steering/Scaling


> +- MAC/VLAN filtering
> +- Packet type information
> +- flow director
> +- cloud filter

Capitalize these for consistency.

> +   ./app/testpmd -c ffff -n 4 -- -i --disable-rss --pkt-filter-
> mode=perfect  --rxq=8 --txq=8 --nb-cores=8 --nb-ports=1
> +   [...]

Long code lines like this don't wrap in the PDF output and should be restricted to
80 characters. You can add a commandline continuation like the following:


.. code-block:: console

   ./app/testpmd -c ffff -n 4 -- -i --disable-rss --pkt-filter-mode=perfect \
                 --rxq=8 --txq=8 --nb-cores=8 --nb-ports=1

Same for the next examples.
> +     MODE:   PERFECT
> +     SUPPORTED FLOW TYPE:  ipv4-frag ipv4-tcp ipv4-udp ipv4-sctp ipv4-
> other ipv6-frag ipv6-tcp ipv6-udp ipv6-sctp ipv6-other l2_payload
> +     FLEX PAYLOAD INFO:

Some of this information could also be wrapped/omitted while retaining the
same information. I'll send you on an example.

John.
--