[v3,2/4] 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>
---
 doc/guides/compressdevs/features/default.ini | 2 +-
 doc/guides/compressdevs/overview.rst         | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)
  

>-----Original Message-----
>From: Pablo de Lara [mailto:pablo.de.lara.guarch@intel.com]
>Sent: 04 July 2018 19:41
>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 v3 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>
>---
> doc/guides/compressdevs/features/default.ini | 2 +-
> doc/guides/compressdevs/overview.rst         | 5 +++++
> 2 files changed, 6 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..b16c36fd6 100644
>--- a/doc/guides/compressdevs/overview.rst
>+++ b/doc/guides/compressdevs/overview.rst
>@@ -10,3 +10,8 @@ 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 mbufs pass-through it, without making any modifications to it.
>--
>2.14.4
[Shally] Rather than mbufs, use generic name input / output buffers. As at some point, we may add alternative to mbufs.
Abd rephrase a bit, such as, in pass-through mode PMD will just copy input to output.

Thanks
Shally
  

> -----Original Message-----
> From: De Lara Guarch, Pablo
> Sent: Wednesday, July 4, 2018 3:11 PM
> To: shally.verma@caviumnetworks.com; ashish.gupta@caviumnetworks.com; Trahe, Fiona
> <fiona.trahe@intel.com>; Daly, Lee <lee.daly@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Subject: [PATCH v3 2/4] 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>
  

> -----Original Message-----
> From: Verma, Shally [mailto:Shally.Verma@cavium.com]
> Sent: Thursday, July 5, 2018 3:41 AM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Gupta, Ashish
> <Ashish.Gupta@cavium.com>; Trahe, Fiona <fiona.trahe@intel.com>; Daly, Lee
> <lee.daly@intel.com>; Sahu, Sunila <Sunila.Sahu@cavium.com>
> Cc: dev@dpdk.org
> Subject: RE: [PATCH v3 2/4] doc: rename compress feature flag
> 
> 
> 
> >-----Original Message-----
> >From: Pablo de Lara [mailto:pablo.de.lara.guarch@intel.com]
> >Sent: 04 July 2018 19:41
> >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 v3 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>
> >---
> > doc/guides/compressdevs/features/default.ini | 2 +-
> > doc/guides/compressdevs/overview.rst         | 5 +++++
> > 2 files changed, 6 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..b16c36fd6 100644
> >--- a/doc/guides/compressdevs/overview.rst
> >+++ b/doc/guides/compressdevs/overview.rst
> >@@ -10,3 +10,8 @@ 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 mbufs pass-through it, without making any modifications to it.
> >--
> >2.14.4
> [Shally] Rather than mbufs, use generic name input / output buffers. As at some
> point, we may add alternative to mbufs.
> Abd rephrase a bit, such as, in pass-through mode PMD will just copy input to
> output.

Ok. Will do.

> 
> Thanks
> Shally
>