[dpdk-dev] [PATCH v2] ethdev: fix documentation for queue start/stop

[dpdk-dev] [PATCH v2] ethdev: fix documentation for queue start/stop

[Nikhil Rao]

Fix documentation for rte_eth_dev_tx/rx_queue_start/stop() functions

Fixes: 2de9f8551ff9 ("ethdev: fix documentation for queue start/stop")

Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
---

v2:

* Updated as per review comments from John McNamara.
* Previous patch did not apply on master.
* Used started/stopped for Rx queue instead of enabled/disabled
  thanks to Ferruh Yigit.

 lib/librte_ether/rte_ethdev.h | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h
index 4dac364..b0fe033 100644
--- a/lib/librte_ether/rte_ethdev.h
+++ b/lib/librte_ether/rte_ethdev.h
@@ -2042,9 +2042,8 @@ int rte_eth_dev_socket_id(uint8_t port_id);
 int rte_eth_dev_is_valid_port(uint8_t port_id);
 
 /**
- * Allocate mbuf from mempool, setup the DMA physical address
- * and then start RX for specified queue of a port. It is used
- * when rx_deferred_start flag of the specified queue is true.
+ * Start specified RX queue of a port. It is used when rx_deferred_start
+ * flag of the specified queue is true.
  *
  * @param port_id
  *   The port identifier of the Ethernet device
@@ -2053,7 +2052,7 @@ int rte_eth_dev_is_valid_port(uint8_t port_id);
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the receive queue is started.
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
@@ -2069,7 +2068,7 @@ int rte_eth_dev_rx_queue_start(uint8_t port_id, uint16_t rx_queue_id);
  *   The value must be in the range [0, nb_rx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the receive queue is stopped.
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
@@ -2086,7 +2085,7 @@ int rte_eth_dev_rx_queue_stop(uint8_t port_id, uint16_t rx_queue_id);
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the transmit queue is started.
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
@@ -2102,7 +2101,7 @@ int rte_eth_dev_tx_queue_start(uint8_t port_id, uint16_t tx_queue_id);
  *   The value must be in the range [0, nb_tx_queue - 1] previously supplied
  *   to rte_eth_dev_configure().
  * @return
- *   - 0: Success, the transmit queue is correctly set up.
+ *   - 0: Success, the transmit queue is stopped.
  *   - -EINVAL: The port_id or the queue_id out of range.
  *   - -ENOTSUP: The function not supported in PMD driver.
  */
-- 
2.7.4

Re: [dpdk-dev] [PATCH v2] ethdev: fix documentation for queue start/stop

[Mcnamara, John]

> -----Original Message-----
> From: Rao, Nikhil
> Sent: Tuesday, July 26, 2016 3:13 PM
> To: dev@dpdk.org
> Cc: thomas.monjalon@6wind.com; Yigit, Ferruh <ferruh.yigit@intel.com>;
> Mcnamara, John <john.mcnamara@intel.com>; Rao, Nikhil
> <nikhil.rao@intel.com>
> Subject: [PATCH v2] ethdev: fix documentation for queue start/stop
> 
> Fix documentation for rte_eth_dev_tx/rx_queue_start/stop() functions
> 
> Fixes: 2de9f8551ff9 ("ethdev: fix documentation for queue start/stop")
> 
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>

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

Re: [dpdk-dev] [PATCH v2] ethdev: fix documentation for queue start/stop

[Thomas Monjalon]

> > Fix documentation for rte_eth_dev_tx/rx_queue_start/stop() functions
> > 
> > Fixes: 2de9f8551ff9 ("ethdev: fix documentation for queue start/stop")
> > 
> > Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks