RE: [PATCH v4] net: add thread-safe crc api

["Kusztal, ArkadiuszX" <arkadiuszx.kusztal@intel.com>]

> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Friday, February 7, 2025 6:13 PM
> To: Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Cc: dev@dpdk.org; ferruh.yigit@amd.com; Ji, Kai <kai.ji@intel.com>; Dooley,
> Brian <brian.dooley@intel.com>
> Subject: Re: [PATCH v4] net: add thread-safe crc api
> 
> On Fri,  7 Feb 2025 06:37:58 +0000
> Arkadiusz Kusztal <arkadiuszx.kusztal@intel.com> wrote:
> 
> > +* net: A thread/process-safe API was introduced. Old and new APIs share the
> same
> > +  function names, but the old one is versioned. Replaced functions are:
> > +  ``rte_net_crc_calc`` and ``rte_net_crc_set_alg``. The new one is
> ``rte_net_crc_free``
> 
> The first sentence should be more specific, and avoid passive voice.
> Follow the style of other release notes in other releases.
> Also, should indicate that versioning is short term (until 25.11).
> 
> Something like:
> 
> * **Changed the API for CRC calculation to be thread safe.**

But this was added under the `API changes` which states "* sample: Add a short 1-2 sentence description of the API change".
This header is from the `New Features`, so should I add it to the `New Features` then?
Otherwise I agree.

> 
>   An opaque context argument was introduced to the net CRC API containing
>   the algorithim type and length. This argument is added to
>   to ``rte_net_crc_calc``, ``rte_net_crc_set_alg`` and freed with
> ``rte_net_crc_free``.
>   These functions are versioned to retain binary compatiabilty until the next LTS
> release.