doc: rename compress feature flag
authorPablo de Lara <pablo.de.lara.guarch@intel.com>
Fri, 6 Jul 2018 05:27:59 +0000 (06:27 +0100)
committerPablo de Lara <pablo.de.lara.guarch@intel.com>
Tue, 10 Jul 2018 22:57:51 +0000 (00:57 +0200)
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>
doc/guides/compressdevs/features/default.ini
doc/guides/compressdevs/overview.rst

index 795fc55..a88414d 100644 (file)
@@ -13,7 +13,7 @@ CPU AVX2       =
 CPU AVX512     =
 CPU NEON       =
 Stateful       =
-By-Pass        =
+Pass-through   =
 Chained mbufs  =
 Deflate        =
 LZS            =
index ca37de1..d01c1a9 100644 (file)
@@ -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).