[PATCH] ethdev: Fix issue in Doxygen for TM API

[PATCH] ethdev: Fix issue in Doxygen for TM API

[Ben Shelton]

The rte_tm_node_wfq_weight_mode_update() API function operates on
non-leaf nodes, not leaf nodes.

Signed-off-by: Ben Shelton <benjamin.h.shelton@intel.com>
---
 lib/librte_ether/rte_tm.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/librte_ether/rte_tm.h b/lib/librte_ether/rte_tm.h
index 2b25a87..f735f84 100644
--- a/lib/librte_ether/rte_tm.h
+++ b/lib/librte_ether/rte_tm.h
@@ -1643,7 +1643,7 @@ rte_tm_node_stats_update(uint16_t port_id,
  * @param[in] port_id
  *   The port identifier of the Ethernet device.
  * @param[in] node_id
- *   Node ID. Needs to be valid leaf node ID.
+ *   Node ID. Needs to be valid non-leaf node ID.
  * @param[in] wfq_weight_mode
  *   WFQ weight mode for each SP priority. When NULL, it indicates that WFQ is
  *   to be used for all priorities. When non-NULL, it points to a pre-allocated
-- 
2.6.4

Re: [PATCH] ethdev: Fix issue in Doxygen for TM API

[Dumitrescu, Cristian]

> -----Original Message-----
> From: Shelton, Benjamin H
> Sent: Wednesday, March 21, 2018 3:46 PM
> To: dev@dpdk.org; Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Cc: Shelton, Benjamin H <benjamin.h.shelton@intel.com>
> Subject: [PATCH] ethdev: Fix issue in Doxygen for TM API
> 
> The rte_tm_node_wfq_weight_mode_update() API function operates on
> non-leaf nodes, not leaf nodes.
> 
> Signed-off-by: Ben Shelton <benjamin.h.shelton@intel.com>
> ---
>  lib/librte_ether/rte_tm.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/lib/librte_ether/rte_tm.h b/lib/librte_ether/rte_tm.h
> index 2b25a87..f735f84 100644
> --- a/lib/librte_ether/rte_tm.h
> +++ b/lib/librte_ether/rte_tm.h
> @@ -1643,7 +1643,7 @@ rte_tm_node_stats_update(uint16_t port_id,
>   * @param[in] port_id
>   *   The port identifier of the Ethernet device.
>   * @param[in] node_id
> - *   Node ID. Needs to be valid leaf node ID.
> + *   Node ID. Needs to be valid non-leaf node ID.
>   * @param[in] wfq_weight_mode
>   *   WFQ weight mode for each SP priority. When NULL, it indicates that
> WFQ is
>   *   to be used for all priorities. When non-NULL, it points to a pre-allocated
> --
> 2.6.4

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied to next-qos tree, thanks!