[v7,11/11] doc: update bbdev feature table

Message ID 1600827906-73771-12-git-send-email-nicolas.chautru@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series bbdev PMD ACC100 |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Chautru, Nicolas Sept. 23, 2020, 2:25 a.m. UTC
  Correcting overview matrix to use acc100 name

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
Acked-by: Liu Tianjiao <Tianjiao.liu@intel.com>
---
 doc/guides/bbdevs/features/acc100.ini | 14 ++++++++++++++
 doc/guides/bbdevs/features/mbc.ini    | 14 --------------
 2 files changed, 14 insertions(+), 14 deletions(-)
 create mode 100644 doc/guides/bbdevs/features/acc100.ini
 delete mode 100644 doc/guides/bbdevs/features/mbc.ini
  

Comments

Akhil Goyal Sept. 28, 2020, 8:19 p.m. UTC | #1
Hi Nicolas,

> 
> Correcting overview matrix to use acc100 name
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> Acked-by: Liu Tianjiao <Tianjiao.liu@intel.com>
> ---
>  doc/guides/bbdevs/features/acc100.ini | 14 ++++++++++++++
>  doc/guides/bbdevs/features/mbc.ini    | 14 --------------
>  2 files changed, 14 insertions(+), 14 deletions(-)
>  create mode 100644 doc/guides/bbdevs/features/acc100.ini
>  delete mode 100644 doc/guides/bbdevs/features/mbc.ini
> 
> diff --git a/doc/guides/bbdevs/features/acc100.ini
> b/doc/guides/bbdevs/features/acc100.ini
> new file mode 100644
> index 0000000..642cd48
> --- /dev/null
> +++ b/doc/guides/bbdevs/features/acc100.ini
> @@ -0,0 +1,14 @@
> +;
> +; Supported features of the 'acc100' bbdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +Turbo Decoder (4G)     = Y
> +Turbo Encoder (4G)     = Y
> +LDPC Decoder (5G)      = Y
> +LDPC Encoder (5G)      = Y
> +LLR/HARQ Compression   = Y
> +External DDR Access    = Y
> +HW Accelerated         = Y
> +BBDEV API              = Y
We normally do not take separate feature set patches for documentation.
These should be split across your patchset, where you are actually adding 
the feature.

Also the release notes in the first patch is not correct as the PMD is not
Complete there. You can add it in the last patch.

> diff --git a/doc/guides/bbdevs/features/mbc.ini
> b/doc/guides/bbdevs/features/mbc.ini
> deleted file mode 100644
> index 78a7b95..0000000
> --- a/doc/guides/bbdevs/features/mbc.ini
> +++ /dev/null
> @@ -1,14 +0,0 @@
> -;
> -; Supported features of the 'mbc' bbdev driver.
> -;
> -; Refer to default.ini for the full list of available PMD features.
> -;
> -[Features]
> -Turbo Decoder (4G)     = Y
> -Turbo Encoder (4G)     = Y
> -LDPC Decoder (5G)      = Y
> -LDPC Encoder (5G)      = Y
> -LLR/HARQ Compression   = Y
> -External DDR Access    = Y
> -HW Accelerated         = Y
> -BBDEV API              = Y

Not sure how was it missed earlier.
Please submit a separate patch for this. This should also be sent for stable backport as well
And add a fixes line.
  
Chautru, Nicolas Sept. 29, 2020, 12:57 a.m. UTC | #2
Hi Akhil, 

> From: Akhil Goyal <akhil.goyal@nxp.com>
> 
> Hi Nicolas,
> 
> >
> > Correcting overview matrix to use acc100 name
> >
> > Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> > Acked-by: Liu Tianjiao <Tianjiao.liu@intel.com>
> > ---
> >  doc/guides/bbdevs/features/acc100.ini | 14 ++++++++++++++
> >  doc/guides/bbdevs/features/mbc.ini    | 14 --------------
> >  2 files changed, 14 insertions(+), 14 deletions(-)  create mode
> > 100644 doc/guides/bbdevs/features/acc100.ini
> >  delete mode 100644 doc/guides/bbdevs/features/mbc.ini
> >
> > diff --git a/doc/guides/bbdevs/features/acc100.ini
> > b/doc/guides/bbdevs/features/acc100.ini
> > new file mode 100644
> > index 0000000..642cd48
> > --- /dev/null
> > +++ b/doc/guides/bbdevs/features/acc100.ini
> > @@ -0,0 +1,14 @@
> > +;
> > +; Supported features of the 'acc100' bbdev driver.
> > +;
> > +; Refer to default.ini for the full list of available PMD features.
> > +;
> > +[Features]
> > +Turbo Decoder (4G)     = Y
> > +Turbo Encoder (4G)     = Y
> > +LDPC Decoder (5G)      = Y
> > +LDPC Encoder (5G)      = Y
> > +LLR/HARQ Compression   = Y
> > +External DDR Access    = Y
> > +HW Accelerated         = Y
> > +BBDEV API              = Y
> We normally do not take separate feature set patches for documentation.
> These should be split across your patchset, where you are actually adding
> the feature.
> 
> Also the release notes in the first patch is not correct as the PMD is not
> Complete there. You can add it in the last patch.

No problem. Updated in the v9 now available. 

> 
> > diff --git a/doc/guides/bbdevs/features/mbc.ini
> > b/doc/guides/bbdevs/features/mbc.ini
> > deleted file mode 100644
> > index 78a7b95..0000000
> > --- a/doc/guides/bbdevs/features/mbc.ini
> > +++ /dev/null
> > @@ -1,14 +0,0 @@
> > -;
> > -; Supported features of the 'mbc' bbdev driver.
> > -;
> > -; Refer to default.ini for the full list of available PMD features.
> > -;
> > -[Features]
> > -Turbo Decoder (4G)     = Y
> > -Turbo Encoder (4G)     = Y
> > -LDPC Decoder (5G)      = Y
> > -LDPC Encoder (5G)      = Y
> > -LLR/HARQ Compression   = Y
> > -External DDR Access    = Y
> > -HW Accelerated         = Y
> > -BBDEV API              = Y
> 
> Not sure how was it missed earlier.
> Please submit a separate patch for this. This should also be sent for stable
> backport as well And add a fixes line.

Yes that was my bad to overlook this. Sent now as well on separate patch. 

More generally the patches related to BBDEV pending to be applied for 20.11 :  
https://patches.dpdk.org/project/dpdk/list/?series=&submitter=chautru&state=&q=&archive=&delegate=

Thanks
Nic
  

Patch

diff --git a/doc/guides/bbdevs/features/acc100.ini b/doc/guides/bbdevs/features/acc100.ini
new file mode 100644
index 0000000..642cd48
--- /dev/null
+++ b/doc/guides/bbdevs/features/acc100.ini
@@ -0,0 +1,14 @@ 
+;
+; Supported features of the 'acc100' bbdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Turbo Decoder (4G)     = Y
+Turbo Encoder (4G)     = Y
+LDPC Decoder (5G)      = Y
+LDPC Encoder (5G)      = Y
+LLR/HARQ Compression   = Y
+External DDR Access    = Y
+HW Accelerated         = Y
+BBDEV API              = Y
diff --git a/doc/guides/bbdevs/features/mbc.ini b/doc/guides/bbdevs/features/mbc.ini
deleted file mode 100644
index 78a7b95..0000000
--- a/doc/guides/bbdevs/features/mbc.ini
+++ /dev/null
@@ -1,14 +0,0 @@ 
-;
-; Supported features of the 'mbc' bbdev driver.
-;
-; Refer to default.ini for the full list of available PMD features.
-;
-[Features]
-Turbo Decoder (4G)     = Y
-Turbo Encoder (4G)     = Y
-LDPC Decoder (5G)      = Y
-LDPC Encoder (5G)      = Y
-LLR/HARQ Compression   = Y
-External DDR Access    = Y
-HW Accelerated         = Y
-BBDEV API              = Y