[dpdk-stable] [PATCH v2] doc: update references to removed function

[dpdk-stable] [PATCH v2] doc: update references to removed function

[Erik Gabriel Carrillo]

Remove references to the (deleted) rte_event_port_enqueue_depth()
function in the Doxygen comments for rte_event_enqueue_burst() and
friends, and replace with references to rte_event_port_attr_get().

Fixes: 78ffab961155 ("eventdev: add port attribute function")
Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc: stable@dpdk.org

Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
---
Changes in v2:
- Add instance that was missed in rte_event_eth_tx_adapter.h (Jerin)

 lib/librte_eventdev/rte_event_eth_tx_adapter.h |  3 ++-
 lib/librte_eventdev/rte_eventdev.h             | 17 +++++++++++------
 2 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/lib/librte_eventdev/rte_event_eth_tx_adapter.h b/lib/librte_eventdev/rte_event_eth_tx_adapter.h
index 1b5278f..9bed12b 100644
--- a/lib/librte_eventdev/rte_event_eth_tx_adapter.h
+++ b/lib/librte_eventdev/rte_event_eth_tx_adapter.h
@@ -322,7 +322,8 @@ rte_event_eth_tx_adapter_event_port_get(uint8_t id, uint8_t *event_port_id);
  *  which contain the event object enqueue operations to be processed.
  * @param nb_events
  *  The number of event objects to enqueue, typically number of
- *  rte_event_port_enqueue_depth() available for this port.
+ *  rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...)
+ *  available for this port.
  *
  * @return
  *   The number of event objects actually enqueued on the event device. The
diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 62edc09..0f0da7f 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -1363,7 +1363,8 @@ __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  *   which contain the event object enqueue operations to be processed.
  * @param nb_events
  *   The number of event objects to enqueue, typically number of
- *   rte_event_port_enqueue_depth() available for this port.
+ *   rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...)
+ *   available for this port.
  *
  * @return
  *   The number of event objects actually enqueued on the event device. The
@@ -1378,7 +1379,7 @@ __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  *   - -ENOSPC  The event port was backpressured and unable to enqueue
  *              one or more events. This error code is only applicable to
  *              closed systems.
- * @see rte_event_port_enqueue_depth()
+ * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH
  */
 static inline uint16_t
 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
@@ -1412,7 +1413,8 @@ rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  *   which contain the event object enqueue operations to be processed.
  * @param nb_events
  *   The number of event objects to enqueue, typically number of
- *   rte_event_port_enqueue_depth() available for this port.
+ *   rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...)
+ *   available for this port.
  *
  * @return
  *   The number of event objects actually enqueued on the event device. The
@@ -1427,7 +1429,8 @@ rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  *   - -ENOSPC  The event port was backpressured and unable to enqueue
  *              one or more events. This error code is only applicable to
  *              closed systems.
- * @see rte_event_port_enqueue_depth() rte_event_enqueue_burst()
+ * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH
+ * @see rte_event_enqueue_burst()
  */
 static inline uint16_t
 rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id,
@@ -1461,7 +1464,8 @@ rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id,
  *   which contain the event object enqueue operations to be processed.
  * @param nb_events
  *   The number of event objects to enqueue, typically number of
- *   rte_event_port_enqueue_depth() available for this port.
+ *   rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...)
+ *   available for this port.
  *
  * @return
  *   The number of event objects actually enqueued on the event device. The
@@ -1476,7 +1480,8 @@ rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id,
  *   - -ENOSPC  The event port was backpressured and unable to enqueue
  *              one or more events. This error code is only applicable to
  *              closed systems.
- * @see rte_event_port_enqueue_depth() rte_event_enqueue_burst()
+ * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH
+ * @see rte_event_enqueue_burst()
  */
 static inline uint16_t
 rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id,
-- 
2.6.4

Re: [dpdk-stable] [dpdk-dev] [PATCH v2] doc: update references to removed function

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Erik Gabriel Carrillo
> Sent: Monday, April 29, 2019 3:38 PM
> To: jerin.jacob@caviumnetworks.com
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: [dpdk-dev] [PATCH v2] doc: update references to removed function
> 
> Remove references to the (deleted) rte_event_port_enqueue_depth() function
> in the Doxygen comments for rte_event_enqueue_burst() and friends, and
> replace with references to rte_event_port_attr_get().
> 
> Fixes: 78ffab961155 ("eventdev: add port attribute function")
> Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> Acked-by: Jerin Jacob <jerinj@marvell.com>


Please mark the previous version as superseded in patchwork.

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-stable] [dpdk-dev] [PATCH v2] doc: update references to removed function

[Thomas Monjalon]

> > Remove references to the (deleted) rte_event_port_enqueue_depth() function
> > in the Doxygen comments for rte_event_enqueue_burst() and friends, and
> > replace with references to rte_event_port_attr_get().
> > 
> > Fixes: 78ffab961155 ("eventdev: add port attribute function")
> > Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> > Cc: stable@dpdk.org
> > 
> > Signed-off-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
> > Acked-by: Jerin Jacob <jerinj@marvell.com>
> 
> 
> Please mark the previous version as superseded in patchwork.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks