[dpdk-stable] patch 'doc: fix a common typo in NIC guides' has been queued to LTS release 17.11.10
luca.boccassi at gmail.com
luca.boccassi at gmail.com
Thu Dec 19 15:33:42 CET 2019
Hi,
FYI, your patch has been queued to LTS release 17.11.10
Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 12/21/19. So please
shout if anyone has objections.
Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.
Thanks.
Luca Boccassi
---
>From 5819d41a32a4be25eda2d531e7a4329bd22c6c51 Mon Sep 17 00:00:00 2001
From: Thierry Herbelot <thierry.herbelot at 6wind.com>
Date: Fri, 18 Oct 2019 17:06:57 +0200
Subject: [PATCH] doc: fix a common typo in NIC guides
[ upstream commit e599bbf442f502fce0671f6b6f39f728b14259a7 ]
'CRC striping' should be spelled 'CRC stripping'.
Fixes: 3eee1f067e7c ("fm10k: add guide")
Fixes: 7a4d9f6676d7 ("doc: add liquidio")
Fixes: f820b5896631 ("doc: add octeontx ethdev driver documentation")
Fixes: 920717e4d8ba ("net/octeontx2: add device start operation")
Fixes: f994cecafdcf ("doc: add ThunderX nicvf")
Signed-off-by: Thierry Herbelot <thierry.herbelot at 6wind.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit at intel.com>
---
doc/guides/nics/fm10k.rst | 4 ++--
doc/guides/nics/liquidio.rst | 4 ++--
doc/guides/nics/octeontx.rst | 4 ++--
doc/guides/nics/thunderx.rst | 4 ++--
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst
index b47fc0db08..470c5798b9 100644
--- a/doc/guides/nics/fm10k.rst
+++ b/doc/guides/nics/fm10k.rst
@@ -172,8 +172,8 @@ the Rx/Tx queues. When switch comes up, a LSC event indicating ``LINK_UP`` is
sent to the app, which can then restart the FM10000 port to resume network
processing.
-CRC striping
-~~~~~~~~~~~~
+CRC stripping
+~~~~~~~~~~~~~
The FM10000 family of NICs strip the CRC for every packets coming into the
host interface. So, CRC will be stripped even when the
diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst
index 7bc1604005..fffa7b5dec 100644
--- a/doc/guides/nics/liquidio.rst
+++ b/doc/guides/nics/liquidio.rst
@@ -225,8 +225,8 @@ Ring size
Number of descriptors for Rx/Tx ring should be in the range 128 to 512.
-CRC striping
-~~~~~~~~~~~~
+CRC stripping
+~~~~~~~~~~~~~
LiquidIO adapters strip ethernet FCS of every packet coming to the host
interface. So, CRC will be stripped even when the ``rxmode.hw_strip_crc``
diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst
index 90bb9e5dbe..8da0867556 100644
--- a/doc/guides/nics/octeontx.rst
+++ b/doc/guides/nics/octeontx.rst
@@ -209,8 +209,8 @@ This driver will only work with ``octeontx_fpavf`` external mempool handler
as it is the most performance effective way for packet allocation and Tx buffer
recycling on OCTEONTX SoC platform.
-CRC striping
-~~~~~~~~~~~~
+CRC stripping
+~~~~~~~~~~~~~
The OCTEONTX SoC family NICs strip the CRC for every packets coming into the
host interface. So, CRC will be stripped even when the
diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
index 45bc690ad2..f8896842da 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
@@ -354,8 +354,8 @@ The nicvf thunderx driver will make use of attached secondary VFs automatically
Limitations
-----------
-CRC striping
-~~~~~~~~~~~~
+CRC stripping
+~~~~~~~~~~~~~
The ThunderX SoC family NICs strip the CRC for every packets coming into the
host interface. So, CRC will be stripped even when the
--
2.20.1
---
Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- - 2019-12-19 14:32:29.296342550 +0000
+++ 0075-doc-fix-a-common-typo-in-NIC-guides.patch 2019-12-19 14:32:26.169299095 +0000
@@ -1,8 +1,10 @@
-From e599bbf442f502fce0671f6b6f39f728b14259a7 Mon Sep 17 00:00:00 2001
+From 5819d41a32a4be25eda2d531e7a4329bd22c6c51 Mon Sep 17 00:00:00 2001
From: Thierry Herbelot <thierry.herbelot at 6wind.com>
Date: Fri, 18 Oct 2019 17:06:57 +0200
Subject: [PATCH] doc: fix a common typo in NIC guides
+[ upstream commit e599bbf442f502fce0671f6b6f39f728b14259a7 ]
+
'CRC striping' should be spelled 'CRC stripping'.
Fixes: 3eee1f067e7c ("fm10k: add guide")
@@ -10,23 +12,21 @@
Fixes: f820b5896631 ("doc: add octeontx ethdev driver documentation")
Fixes: 920717e4d8ba ("net/octeontx2: add device start operation")
Fixes: f994cecafdcf ("doc: add ThunderX nicvf")
-Cc: stable at dpdk.org
Signed-off-by: Thierry Herbelot <thierry.herbelot at 6wind.com>
Reviewed-by: Ferruh Yigit <ferruh.yigit at intel.com>
---
- doc/guides/nics/fm10k.rst | 4 ++--
- doc/guides/nics/liquidio.rst | 4 ++--
- doc/guides/nics/octeontx.rst | 4 ++--
- doc/guides/nics/octeontx2.rst | 4 ++--
- doc/guides/nics/thunderx.rst | 4 ++--
- 5 files changed, 10 insertions(+), 10 deletions(-)
+ doc/guides/nics/fm10k.rst | 4 ++--
+ doc/guides/nics/liquidio.rst | 4 ++--
+ doc/guides/nics/octeontx.rst | 4 ++--
+ doc/guides/nics/thunderx.rst | 4 ++--
+ 4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst
-index 764e089c86..20a1cde535 100644
+index b47fc0db08..470c5798b9 100644
--- a/doc/guides/nics/fm10k.rst
+++ b/doc/guides/nics/fm10k.rst
-@@ -135,8 +135,8 @@ the Rx/Tx queues. When switch comes up, a LSC event indicating ``LINK_UP`` is
+@@ -172,8 +172,8 @@ the Rx/Tx queues. When switch comes up, a LSC event indicating ``LINK_UP`` is
sent to the app, which can then restart the FM10000 port to resume network
processing.
@@ -36,12 +36,12 @@
+~~~~~~~~~~~~~
The FM10000 family of NICs strip the CRC for every packets coming into the
- host interface. So, keeping CRC is not supported.
+ host interface. So, CRC will be stripped even when the
diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst
-index e2a38004d0..0534146720 100644
+index 7bc1604005..fffa7b5dec 100644
--- a/doc/guides/nics/liquidio.rst
+++ b/doc/guides/nics/liquidio.rst
-@@ -190,7 +190,7 @@ Ring size
+@@ -225,8 +225,8 @@ Ring size
Number of descriptors for Rx/Tx ring should be in the range 128 to 512.
@@ -50,42 +50,28 @@
+CRC stripping
+~~~~~~~~~~~~~
- LiquidIO adapters strip ethernet FCS of every packet coming to the host interface.
+ LiquidIO adapters strip ethernet FCS of every packet coming to the host
+ interface. So, CRC will be stripped even when the ``rxmode.hw_strip_crc``
diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst
-index 012a3ec21f..3c19c912db 100644
+index 90bb9e5dbe..8da0867556 100644
--- a/doc/guides/nics/octeontx.rst
+++ b/doc/guides/nics/octeontx.rst
-@@ -161,8 +161,8 @@ This driver will only work with ``octeontx_fpavf`` external mempool handler
+@@ -209,8 +209,8 @@ This driver will only work with ``octeontx_fpavf`` external mempool handler
as it is the most performance effective way for packet allocation and Tx buffer
- recycling on OCTEON TX SoC platform.
-
--CRC striping
--~~~~~~~~~~~~
-+CRC stripping
-+~~~~~~~~~~~~~
-
- The OCTEON TX SoC family NICs strip the CRC for every packets coming into the
- host interface irrespective of the offload configuration.
-diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst
-index 3b567a55e8..fc8a130fb9 100644
---- a/doc/guides/nics/octeontx2.rst
-+++ b/doc/guides/nics/octeontx2.rst
-@@ -188,8 +188,8 @@ The OCTEON TX2 SoC family NIC has inbuilt HW assisted external mempool manager.
- as it is performance wise most effective way for packet allocation and Tx buffer
- recycling on OCTEON TX2 SoC platform.
+ recycling on OCTEONTX SoC platform.
-CRC striping
-~~~~~~~~~~~~
+CRC stripping
+~~~~~~~~~~~~~
- The OCTEON TX2 SoC family NICs strip the CRC for every packet being received by
- the host interface irrespective of the offload configuration.
+ The OCTEONTX SoC family NICs strip the CRC for every packets coming into the
+ host interface. So, CRC will be stripped even when the
diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
-index 53eaec72a7..3b75a9a9af 100644
+index 45bc690ad2..f8896842da 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
-@@ -331,8 +331,8 @@ Example:
+@@ -354,8 +354,8 @@ The nicvf thunderx driver will make use of attached secondary VFs automatically
Limitations
-----------
@@ -95,7 +81,7 @@
+~~~~~~~~~~~~~
The ThunderX SoC family NICs strip the CRC for every packets coming into the
- host interface irrespective of the offload configuration.
+ host interface. So, CRC will be stripped even when the
--
2.20.1
More information about the stable
mailing list