Re: [RFC PATCH 3/3] doc: add introduction for fm10k FTAG based forwarding

Hi, John

-----Original Message-----
From: Mcnamara, John
Sent: Tuesday, January 12, 2016 10:16 PM
To: Wang, Xiao W <redacted>; Chen, Jing D
[off-list ref]; Richardson, Bruce [off-list ref]
Cc: dev@dpdk.org
Subject: RE: [dpdk-dev] [RFC PATCH 3/3] doc: add introduction for fm10k
FTAG based forwarding

quoted

-----Original Message-----
From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Wang Xiao W
Sent: Tuesday, January 5, 2016 12:32 PM
To: Chen, Jing D; Richardson, Bruce
Cc: dev@dpdk.org
Subject: [dpdk-dev] [RFC PATCH 3/3] doc: add introduction for fm10k
FTAG based forwarding

Add a brief introduction on FTAG, describes what's FTAG and how it
works in forwarding, introduction on how to run fm10k with FTAG is
also included.

Signed-off-by: Wang Xiao W <redacted>
---
 doc/guides/nics/fm10k.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst

index
4206b7f..d82bf41 100644

--- a/doc/guides/nics/fm10k.rst
+++ b/doc/guides/nics/fm10k.rst

@@ -34,6 +34,19 @@ FM10K Poll Mode Driver  The FM10K poll mode driver

library provides support for the Intel FM10000
 (FM10K) family of 40GbE/100GbE adapters.

Hi,

Some very minor comments.

quoted

+FTAG Based Forwarding of FM10K
+------------------------------

The Documentation Guidelines say to put a newline after section headers.

quoted

+FTAG Based Forwarding is a unique feature of FM10K. The FM10K family
+of NICs support the addition of a Fabric Tag (FTAG) to carry special
information.
+The FTAG is placed at the beginning of the frame, it contains
+information such as where the packet comes from and goes, the vlan tag.

s/the vlan tag/and the vlan tag

quoted

+In FTAG based forwarding mode, the switch logic forwards packets
+according to glort (global resource tag) information, other than the

s/other/rather

quoted

+mac and vlan table. Now this feature works only on PF.

s/Now/Currently

quoted

+
+To enable this feature, turn CONFIG_RTE_LIBRTE_FM10K_FTAG_FWD to y

in

In general variable and config names should be in fixed width quotes:

``CONFIG_RTE_LIBRTE_FM10K_FTAG_FWD``

quoted

+the configuration file. A unit test case fm10k_ftag_autotest is for

s/for/provided for

John.
--

Many thanks for your comments, I'll change accordingly.