From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Date: Fri, 6 Jul 2018 05:27:59 +0000 (+0100)
Subject: doc: rename compress feature flag
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=64454ff20e5537ddff585f26ecce4657cb97cf12;p=dpdk.git

doc: rename compress feature flag

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>
Acked-by: Shally Verma <shally.verma@caviumnetworks.com>
---

diff --git a/doc/guides/compressdevs/features/default.ini b/doc/guides/compressdevs/features/default.ini
index 795fc5577b..a88414d233 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 ca37de1756..d01c1a9665 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).