[v4,10/10] doc: announce bbdev changes

  Update of the release notes for BBDEV features add
and extension of ABI in previous commit.

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/rel_notes/release_19_08.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
  

> -----Original Message-----
> From: Chautru, Nicolas
> Sent: Monday 24 June 2019 03:53
> To: akhil.goyal@nxp.com; dev@dpdk.org
> Cc: thomas@monjalon.net; Yigit, Ferruh <ferruh.yigit@intel.com>;
> Mokhtar, Amr <amr.mokhtar@intel.com>; Chautru, Nicolas
> <nicolas.chautru@intel.com>
> Subject: [PATCH v4 10/10] doc: announce bbdev changes
> 
> Update of the release notes for BBDEV features add
> and extension of ABI in previous commit.
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> ---

Acked-by: Amr Mokhtar <amr.mokhtar@intel.com>
  

Hi Nicolas,

> 
> Update of the release notes for BBDEV features add
> and extension of ABI in previous commit.
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> ---
>  doc/guides/rel_notes/release_19_08.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_19_08.rst
> b/doc/guides/rel_notes/release_19_08.rst
> index 8c3932d..35d3a09 100644
> --- a/doc/guides/rel_notes/release_19_08.rst
> +++ b/doc/guides/rel_notes/release_19_08.rst
> @@ -88,6 +88,19 @@ New Features
>    * Added multi-queue support to allow one af_xdp vdev with multiple netdev
>      queues
> 
> +* **Added a FPGA_LTE_FEC bbdev PMD.**
> +
> +  Added the new ``fpga_lte_fec`` bbdev driver for the Intel® FPGA PAC
> +  (Programmable  Acceleration Card) N3000.  See the
> +  :doc:`../bbdevs/fpga_lte_fec` BBDEV guide for more details on this new driver.
> +
> +* **Updated TURBO_SW bbdev PMD.**
> +
> +  Updated the ``turbo_sw`` bbdev driver with changes including:
> +
> +  * Added option to build the driver with or without dependency of external
> +    SDK libraries.
> +  * Added support for 5GNR encode/decode operations.
> 
>  Removed Items
>  -------------
> @@ -140,6 +153,8 @@ ABI Changes
>     Also, make sure to start the actual text at the margin.
>     =========================================================
> 
> +* bbdev: New parameters added to support 5GNR operations.
> +
> 
>  Shared Library Versions
>  -----------------------
> --
> 1.8.3.1

Release note changes should be part of the same patch which is adding that change.

One more thing, if there is a change in ABI, should you also increment the bbdev ABI version?

Please also send a rebased version of your patchset, so that builds can be verified by CI. The dependent patches are applied on the sub-tree.

-Akhil
  

Hi Akhil,

>> 
>> Update of the release notes for BBDEV features add and extension of 
>> ABI in previous commit.
>> 
>> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
>> ---
>>  doc/guides/rel_notes/release_19_08.rst | 15 +++++++++++++++
>>  1 file changed, 15 insertions(+)
>> 
>> diff --git a/doc/guides/rel_notes/release_19_08.rst
>> b/doc/guides/rel_notes/release_19_08.rst
>> index 8c3932d..35d3a09 100644
>> --- a/doc/guides/rel_notes/release_19_08.rst
>> +++ b/doc/guides/rel_notes/release_19_08.rst
>> @@ -88,6 +88,19 @@ New Features
>>    * Added multi-queue support to allow one af_xdp vdev with multiple netdev
>>      queues
>> 
>> +* **Added a FPGA_LTE_FEC bbdev PMD.**
>> +
>> +  Added the new ``fpga_lte_fec`` bbdev driver for the Intel® FPGA 
>> + PAC  (Programmable  Acceleration Card) N3000.  See the  
>> + :doc:`../bbdevs/fpga_lte_fec` BBDEV guide for more details on this new driver.
>> +
>> +* **Updated TURBO_SW bbdev PMD.**
>> +
>> +  Updated the ``turbo_sw`` bbdev driver with changes including:
>> +
>> +  * Added option to build the driver with or without dependency of external
>> +    SDK libraries.
>> +  * Added support for 5GNR encode/decode operations.
>> 
>>  Removed Items
>>  -------------
>> @@ -140,6 +153,8 @@ ABI Changes
>>     Also, make sure to start the actual text at the margin.
>>     =========================================================
>> 
>> +* bbdev: New parameters added to support 5GNR operations.
>> +
>> 
>>  Shared Library Versions
>>  -----------------------
>> --
>> 1.8.3.1
>
>Release note changes should be part of the same patch which is adding that change.

No problem, I am pushing an updated serie :  https://patches.dpdk.org/project/dpdk/list/?series=5259

>One more thing, if there is a change in ABI, should you also increment the bbdev ABI version?

The bbdev ABI is still marked as __rte_experimental hence I don't believe we have yet to increment it. 

>Please also send a rebased version of your patchset, so that builds can be verified by CI. The dependent patches are applied on the sub-tree.

OK, I did this on the serie above. Note that the previous was already verified with CI since I kept the dependency within the previous serie. Still cleaner now, you should just have to apply the serie as is now. 

Thanks!
Nic
  

01/07/2019 20:14, Chautru, Nicolas:
> 
> >One more thing, if there is a change in ABI, should you also increment the bbdev ABI version?
> 
> The bbdev ABI is still marked as __rte_experimental hence I don't believe we have yet to increment it.

ABI version and experimental state are two different things.
I think we should upgrade the version even for experimental libraries.
  

>-----Original Message-----
>From: Thomas Monjalon [mailto:thomas@monjalon.net] 
>Sent: Monday, July 1, 2019 12:18 PM
>To: Chautru, Nicolas <nicolas.chautru@intel.com>
>Cc: Akhil Goyal <akhil.goyal@nxp.com>; dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Mokhtar, Amr <amr.mokhtar@intel.com>
>Subject: Re: [PATCH v4 10/10] doc: announce bbdev changes
>
>01/07/2019 20:14, Chautru, Nicolas:
>> 
>> >One more thing, if there is a change in ABI, should you also increment the bbdev ABI version?
>> 
>> The bbdev ABI is still marked as __rte_experimental hence I don't believe we have yet to increment it.
>
>ABI version and experimental state are two different things.
>I think we should upgrade the version even for experimental libraries.

Thanks Thomas. 

Bruce, Ferruh can you comment whether bumping ABI version is required for __rte_experimental API? Arguably the documentation may be interpreted either way : https://doc.dpdk.org/guides-18.08/contributing/versioning.html 

In the specific case of bbdev change in that serie, note that only new operations (for 5GNR signal processing) and related symbols are being added. 
Previous releases included BBDEV API changes without updating ABI version number ( librte_bbdev.so.1). 

Thanks for letting me know, in both cases we may make it more explicit on the versioning page. 
Nic
  

On Mon, Jul 01, 2019 at 09:27:56PM +0100, Chautru, Nicolas wrote:
> 
> >-----Original Message-----
> >From: Thomas Monjalon [mailto:thomas@monjalon.net] 
> >Sent: Monday, July 1, 2019 12:18 PM
> >To: Chautru, Nicolas <nicolas.chautru@intel.com>
> >Cc: Akhil Goyal <akhil.goyal@nxp.com>; dev@dpdk.org; Yigit, Ferruh <ferruh.yigit@intel.com>; Mokhtar, Amr <amr.mokhtar@intel.com>
> >Subject: Re: [PATCH v4 10/10] doc: announce bbdev changes
> >
> >01/07/2019 20:14, Chautru, Nicolas:
> >> 
> >> >One more thing, if there is a change in ABI, should you also increment the bbdev ABI version?
> >> 
> >> The bbdev ABI is still marked as __rte_experimental hence I don't believe we have yet to increment it.
> >
> >ABI version and experimental state are two different things.
> >I think we should upgrade the version even for experimental libraries.
> 
> Thanks Thomas. 
> 
> Bruce, Ferruh can you comment whether bumping ABI version is required for __rte_experimental API? Arguably the documentation may be interpreted either way : https://doc.dpdk.org/guides-18.08/contributing/versioning.html 
> 
> In the specific case of bbdev change in that serie, note that only new operations (for 5GNR signal processing) and related symbols are being added. 
> Previous releases included BBDEV API changes without updating ABI version number ( librte_bbdev.so.1). 
> 
> Thanks for letting me know, in both cases we may make it more explicit on the versioning page. 
> Nic

I think there may be some misunderstanding here, so long as no existing
APIs are changed or removed, we don't bump the ABI version.

/Bruce