[v4,2/4] doc: rename compress feature flag

Message ID 20180706025430.21342-2-pablo.de.lara.guarch@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Pablo de Lara Guarch
Headers
Series [v4,1/4] doc: cleanup ISA-L PMD feature matrix |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

De Lara Guarch, Pablo July 6, 2018, 2:54 a.m. UTC
  Renamed feature "Bypass" to "Pass-through",
as it is a more explicit name, meaning that the PMD
is capable of passing the mbufs through it,
without making any modifications (i.e.. NULL algorithm).

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
---

v4:
- Rephrased pass-through feature comment (Shally)

 doc/guides/compressdevs/features/default.ini | 2 +-
 doc/guides/compressdevs/overview.rst         | 6 ++++++
 2 files changed, 7 insertions(+), 1 deletion(-)
  

Comments

Verma, Shally July 6, 2018, 12:17 p.m. UTC | #1
>-----Original Message-----
>From: Pablo de Lara [mailto:pablo.de.lara.guarch@intel.com]
>Sent: 06 July 2018 08:24
>To: Verma, Shally <Shally.Verma@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>; fiona.trahe@intel.com;
>lee.daly@intel.com
>Cc: dev@dpdk.org; Pablo de Lara <pablo.de.lara.guarch@intel.com>
>Subject: [PATCH v4 2/4] doc: rename compress feature flag
>
>External Email
>
>Renamed feature "Bypass" to "Pass-through",
>as it is a more explicit name, meaning that the PMD
>is capable of passing the mbufs through it,
>without making any modifications (i.e.. NULL algorithm).
>
>Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
>Acked-by: Fiona Trahe <fiona.trahe@intel.com>
>---
>
>v4:
>- Rephrased pass-through feature comment (Shally)
>
> doc/guides/compressdevs/features/default.ini | 2 +-
> doc/guides/compressdevs/overview.rst         | 6 ++++++
> 2 files changed, 7 insertions(+), 1 deletion(-)
>
>diff --git a/doc/guides/compressdevs/features/default.ini b/doc/guides/compressdevs/features/default.ini
>index 795fc5577..a88414d23 100644
>--- a/doc/guides/compressdevs/features/default.ini
>+++ b/doc/guides/compressdevs/features/default.ini
>@@ -13,7 +13,7 @@ CPU AVX2       =
> CPU AVX512     =
> CPU NEON       =
> Stateful       =
>-By-Pass        =
>+Pass-through   =
> Chained mbufs  =
> Deflate        =
> LZS            =
>diff --git a/doc/guides/compressdevs/overview.rst b/doc/guides/compressdevs/overview.rst
>index ca37de175..d01c1a966 100644
>--- a/doc/guides/compressdevs/overview.rst
>+++ b/doc/guides/compressdevs/overview.rst
>@@ -10,3 +10,9 @@ Supported Feature Flags
> .. _table_compression_pmd_features:
>
> .. include:: overview_feature_table.txt
>+
>+.. Note::
>+
>+   - "Pass-through" feature flag refers to the ability of the PMD
>+     to let input buffers pass-through it, copying the input to the output,
>+     without making any modifications to it (no compression done).
>--
>2.14.4
Acked-by: Shally Verma <shally.verma@caviumnetworks.com>
  

Patch

diff --git a/doc/guides/compressdevs/features/default.ini b/doc/guides/compressdevs/features/default.ini
index 795fc5577..a88414d23 100644
--- a/doc/guides/compressdevs/features/default.ini
+++ b/doc/guides/compressdevs/features/default.ini
@@ -13,7 +13,7 @@  CPU AVX2       =
 CPU AVX512     =
 CPU NEON       =
 Stateful       =
-By-Pass        =
+Pass-through   =
 Chained mbufs  =
 Deflate        =
 LZS            =
diff --git a/doc/guides/compressdevs/overview.rst b/doc/guides/compressdevs/overview.rst
index ca37de175..d01c1a966 100644
--- a/doc/guides/compressdevs/overview.rst
+++ b/doc/guides/compressdevs/overview.rst
@@ -10,3 +10,9 @@  Supported Feature Flags
 .. _table_compression_pmd_features:
 
 .. include:: overview_feature_table.txt
+
+.. Note::
+
+   - "Pass-through" feature flag refers to the ability of the PMD
+     to let input buffers pass-through it, copying the input to the output,
+     without making any modifications to it (no compression done).