diff mbox series

doc: announce marking bus object as internal

Message ID 20220630094153.2066208-1-david.marchand@redhat.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: announce marking bus object as internal | expand

Checks

Context Check Description
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

David Marchand June 30, 2022, 9:41 a.m. UTC
rte_bus is unnecessarily exposed in the public API/ABI.
Besides, we had cases where extending rte_bus was necessary.
Announce that rte_bus will be made opaque in the public API and mark
associated API as internal.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
A RFC series of the intended changes is available at:
https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both

---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Bruce Richardson June 30, 2022, 9:54 a.m. UTC | #1
On Thu, Jun 30, 2022 at 11:41:53AM +0200, David Marchand wrote:
> rte_bus is unnecessarily exposed in the public API/ABI.
> Besides, we had cases where extending rte_bus was necessary.
> Announce that rte_bus will be made opaque in the public API and mark
> associated API as internal.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> A RFC series of the intended changes is available at:
> https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both
> 
> ---
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Thomas Monjalon June 30, 2022, 2:36 p.m. UTC | #2
30/06/2022 11:54, Bruce Richardson:
> On Thu, Jun 30, 2022 at 11:41:53AM +0200, David Marchand wrote:
> > rte_bus is unnecessarily exposed in the public API/ABI.
> > Besides, we had cases where extending rte_bus was necessary.
> > Announce that rte_bus will be made opaque in the public API and mark
> > associated API as internal.
> > 
> > Signed-off-by: David Marchand <david.marchand@redhat.com>
> > ---
> > A RFC series of the intended changes is available at:
> > https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both
> > 
> > ---
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Kevin Laatz July 4, 2022, 2:29 p.m. UTC | #3
On 30/06/2022 10:41, David Marchand wrote:
> rte_bus is unnecessarily exposed in the public API/ABI.
> Besides, we had cases where extending rte_bus was necessary.
> Announce that rte_bus will be made opaque in the public API and mark
> associated API as internal.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> A RFC series of the intended changes is available at:
> https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both
>
> ---
>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
Acked-by: Kevin Laatz <kevin.laatz@intel.com>
Hemant Agrawal July 5, 2022, 4:43 a.m. UTC | #4
Acked-by:  Hemant Agrawal <hemant.agrawal@nxp.com>

On 7/4/2022 7:59 PM, Kevin Laatz wrote:
> On 30/06/2022 10:41, David Marchand wrote:
>> rte_bus is unnecessarily exposed in the public API/ABI.
>> Besides, we had cases where extending rte_bus was necessary.
>> Announce that rte_bus will be made opaque in the public API and mark
>> associated API as internal.
>>
>> Signed-off-by: David Marchand <david.marchand@redhat.com>
>> ---
>> A RFC series of the intended changes is available at:
>> https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both 
>>
>>
>> ---
>>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>>   1 file changed, 6 insertions(+)
>>
> Acked-by: Kevin Laatz <kevin.laatz@intel.com>
>
Andrew Rybchenko July 5, 2022, 6:59 a.m. UTC | #5
On 7/5/22 07:43, Hemant Agrawal wrote:
> Acked-by:  Hemant Agrawal <hemant.agrawal@nxp.com>
> 
> On 7/4/2022 7:59 PM, Kevin Laatz wrote:
>> On 30/06/2022 10:41, David Marchand wrote:
>>> rte_bus is unnecessarily exposed in the public API/ABI.
>>> Besides, we had cases where extending rte_bus was necessary.
>>> Announce that rte_bus will be made opaque in the public API and mark
>>> associated API as internal.
>>>
>>> Signed-off-by: David Marchand <david.marchand@redhat.com>
>>> ---
>>> A RFC series of the intended changes is available at:
>>> https://patches.dpdk.org/project/dpdk/list/?series=23811&state=%2A&archive=both 
>>>
>>>
>>> ---
>>>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>>>   1 file changed, 6 insertions(+)
>>>
>> Acked-by: Kevin Laatz <kevin.laatz@intel.com>
>>

Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Thomas Monjalon July 15, 2022, 4:16 p.m. UTC | #6
30/06/2022 11:41, David Marchand:
> rte_bus is unnecessarily exposed in the public API/ABI.
> Besides, we had cases where extending rte_bus was necessary.
> Announce that rte_bus will be made opaque in the public API and mark
> associated API as internal.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

    Acked-by: Bruce Richardson <bruce.richardson@intel.com>
    Acked-by: Thomas Monjalon <thomas@monjalon.net>
    Acked-by: Kevin Laatz <kevin.laatz@intel.com>
    Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
    Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 64d649777a..a9fd6676be 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -32,6 +32,12 @@  Deprecation Notices
   ``__atomic_thread_fence`` must be used for patches that need to be merged in
   20.08 onwards. This change will not introduce any performance degradation.
 
+* bus: The ``rte_bus`` object will be made opaque in DPDK 22.11.
+  The goal is to remove it from the public ABI and make this object extendable.
+  As a side effect, registering a bus will be marked as an internal API:
+  external users may still register their bus using a new driver header (see
+  ``enable_driver_sdk`` meson option).
+
 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated and will
   be removed in DPDK 22.11. The replacement macro
   ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.