[v3,1/7] ethdev: deprecate descriptor status check API
diff mbox series

Message ID 20200909111220.1195759-1-ferruh.yigit@intel.com
State Superseded
Delegated to: Ferruh Yigit
Headers show
Series
  • [v3,1/7] ethdev: deprecate descriptor status check API
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Ferruh Yigit Sept. 9, 2020, 11:12 a.m. UTC
Marking 'rte_eth_rx_descriptor_done()' API as deprecated.
``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
APIs can be used as replacement.

Plan is to remove the API on 21.11 release.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---

Cc: David Marchand <david.marchand@redhat.com>
v3:
* Just deprecating the 'rte_eth_rx_descriptor_done()' API without
  removing it to stick to the original plan.
---
 doc/guides/rel_notes/deprecation.rst   | 2 +-
 doc/guides/rel_notes/release_20_11.rst | 2 ++
 lib/librte_ethdev/rte_ethdev.h         | 1 +
 3 files changed, 4 insertions(+), 1 deletion(-)

Comments

David Marchand Sept. 9, 2020, 12:07 p.m. UTC | #1
On Wed, Sep 9, 2020 at 1:12 PM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>
> Marking 'rte_eth_rx_descriptor_done()' API as deprecated.
> ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
> APIs can be used as replacement.
>
> Plan is to remove the API on 21.11 release.
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> ---
>
> Cc: David Marchand <david.marchand@redhat.com>
> v3:
> * Just deprecating the 'rte_eth_rx_descriptor_done()' API without
>   removing it to stick to the original plan.

LGTM, thanks.

For the series,
Acked-by: David Marchand <david.marchand@redhat.com>

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 279eccb04a..35c676e262 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -214,7 +214,7 @@  Deprecation Notices
   https://mails.dpdk.org/archives/dev/2020-July/176135.html.
 
 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
-  will be deprecated in 20.11 and will be removed in 21.11.
+  will be removed in 21.11.
   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
   APIs can be used as replacement.
 
diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
index df227a1773..a7d57b001d 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -84,6 +84,8 @@  API Changes
    Also, make sure to start the actual text at the margin.
    =======================================================
 
+* ``rte_eth_rx_descriptor_done()`` API has deprecated.
+
 
 ABI Changes
 -----------
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index f30245b102..eb6cd01f8d 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -4567,6 +4567,7 @@  rte_eth_rx_queue_count(uint16_t port_id, uint16_t queue_id)
  *  - (-ENODEV) if *port_id* invalid.
  *  - (-ENOTSUP) if the device does not support this function
  */
+__rte_deprecated
 static inline int
 rte_eth_rx_descriptor_done(uint16_t port_id, uint16_t queue_id, uint16_t offset)
 {