diff mbox

[dpdk-dev] mempool: add notice to change mempool API/ABI

Message ID 20170713091231.13314-1-santosh.shukla@caviumnetworks.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Santosh Shukla July 13, 2017, 9:12 a.m. UTC 
  An API/ABI change is planned for 17.11 to change following

* Remove unused flag param from rte_mempool_generic_get and _put.
* Change data type for mempool 'flag' from int to unsigned int.
  Refer [1].
* Add struct rte_mempool * param into func rte_mempool_xmem_size,
  rte_mempool_xmem_usage to make it mempool aware.
  Refer [2].

[1] http://dpdk.org/dev/patchwork/patch/25603/
[2] http://dpdk.org/dev/patchwork/patch/25605/

Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Olivier Matz July 20, 2017, 8:46 a.m. UTC | #1 
On Thu, 13 Jul 2017 09:12:31 +0000, Santosh Shukla <santosh.shukla@caviumnetworks.com> wrote:
> [PATCH] mempool: add notice to change mempool API/ABI

I think the usual titles for these notices are more:

doc: announce API/ABI changes for mempool

Ideally, the title should describe more precisely the kind of
changes. In that particular case, it looks quite difficult,
so just saying "mempool" looks okay. Maybe Thomas will prefer
one entry per change, I don't know.


> An API/ABI change is planned for 17.11 to change following
> 
> * Remove unused flag param from rte_mempool_generic_get and _put.
> * Change data type for mempool 'flag' from int to unsigned int.
>   Refer [1].
> * Add struct rte_mempool * param into func rte_mempool_xmem_size,
>   rte_mempool_xmem_usage to make it mempool aware.
>   Refer [2].
> 
> [1] http://dpdk.org/dev/patchwork/patch/25603/
> [2] http://dpdk.org/dev/patchwork/patch/25605/
> 
> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 257dcba32..7abb30f5f 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -64,3 +64,11 @@ Deprecation Notices
>    be removed in 17.11:
>  
>    - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
> +
> +* mempool: The following will be modified in 17.11:

I think an empty line is required here, else the generated pdf will
be incorrect.

> +  - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
> +    the mempool flag status so adding new param rte_mempool in those API.
> +  - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
> +    and ``rte_mempool_generic_get`` API.
> +  - ``rte_mempool`` flags data type will changed from int to
> +    unsigned int.
Santosh Shukla July 20, 2017, 9:27 a.m. UTC | #2 
On Thursday 20 July 2017 02:16 PM, Olivier Matz wrote:

> On Thu, 13 Jul 2017 09:12:31 +0000, Santosh Shukla <santosh.shukla@caviumnetworks.com> wrote:
>> [PATCH] mempool: add notice to change mempool API/ABI
> I think the usual titles for these notices are more:
>
> doc: announce API/ABI changes for mempool

in v2.

> Ideally, the title should describe more precisely the kind of
> changes. In that particular case, it looks quite difficult,
> so just saying "mempool" looks okay. Maybe Thomas will prefer
> one entry per change, I don't know.
>
Thomas, Are you fine with approach?

>> An API/ABI change is planned for 17.11 to change following
>>
>> * Remove unused flag param from rte_mempool_generic_get and _put.
>> * Change data type for mempool 'flag' from int to unsigned int.
>>   Refer [1].
>> * Add struct rte_mempool * param into func rte_mempool_xmem_size,
>>   rte_mempool_xmem_usage to make it mempool aware.
>>   Refer [2].
>>
>> [1] http://dpdk.org/dev/patchwork/patch/25603/
>> [2] http://dpdk.org/dev/patchwork/patch/25605/
>>
>> Signed-off-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
>> ---
>>  doc/guides/rel_notes/deprecation.rst | 8 ++++++++
>>  1 file changed, 8 insertions(+)
>>
>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>> index 257dcba32..7abb30f5f 100644
>> --- a/doc/guides/rel_notes/deprecation.rst
>> +++ b/doc/guides/rel_notes/deprecation.rst
>> @@ -64,3 +64,11 @@ Deprecation Notices
>>    be removed in 17.11:
>>  
>>    - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
>> +
>> +* mempool: The following will be modified in 17.11:
> I think an empty line is required here, else the generated pdf will
> be incorrect.

in v2. Thanks.

>> +  - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
>> +    the mempool flag status so adding new param rte_mempool in those API.
>> +  - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
>> +    and ``rte_mempool_generic_get`` API.
>> +  - ``rte_mempool`` flags data type will changed from int to
>> +    unsigned int.
Thomas Monjalon July 20, 2017, 11:26 a.m. UTC | #3 
20/07/2017 12:27, santosh:
> On Thursday 20 July 2017 02:16 PM, Olivier Matz wrote:
> 
> > On Thu, 13 Jul 2017 09:12:31 +0000, Santosh Shukla <santosh.shukla@caviumnetworks.com> wrote:
> >> [PATCH] mempool: add notice to change mempool API/ABI
> > I think the usual titles for these notices are more:
> >
> > doc: announce API/ABI changes for mempool
> 
> in v2.
> 
> > Ideally, the title should describe more precisely the kind of
> > changes. In that particular case, it looks quite difficult,
> > so just saying "mempool" looks okay. Maybe Thomas will prefer
> > one entry per change, I don't know.
> >
> Thomas, Are you fine with approach?

Yes it is OK.
The important words are "announce", "API" and "mempool".
As you are breaking the API, no need to be explicit about ABI.
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 257dcba32..7abb30f5f 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -64,3 +64,11 @@  Deprecation Notices
   be removed in 17.11:
 
   - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
+
+* mempool: The following will be modified in 17.11:
+  - ``rte_mempool_xmem_size`` and ``rte_mempool_xmem_usage`` need to know
+    the mempool flag status so adding new param rte_mempool in those API.
+  - Removing __rte_unused int flag param from ``rte_mempool_generic_put``
+    and ``rte_mempool_generic_get`` API.
+  - ``rte_mempool`` flags data type will changed from int to
+    unsigned int.