eventdev: fix xstats documentation typo
diff mbox series

Message ID 20181203200504.3176-1-gage.eads@intel.com
State Accepted, archived
Delegated to: Jerin Jacob
Headers show
Series
  • eventdev: fix xstats documentation typo
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/checkpatch success coding style OK

Commit Message

Eads, Gage Dec. 3, 2018, 8:05 p.m. UTC
The eventdev extended stats documentation referred to two non-existent
functions, rte_eventdev_xstats_get and rte_eventdev_get_xstats_by_name.

Fixes: 3ed7fc039a ("eventdev: add extended stats")
Cc: stable@dpdk.org

Signed-off-by: Gage Eads <gage.eads@intel.com>
---
 lib/librte_eventdev/rte_eventdev.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Jerin Jacob Kollanukkaran Dec. 16, 2018, 5:31 p.m. UTC | #1
On Mon, 2018-12-03 at 14:05 -0600, Gage Eads wrote:
> The eventdev extended stats documentation referred to two non-
> existent
> functions, rte_eventdev_xstats_get and
> rte_eventdev_get_xstats_by_name.
> 
> Fixes: 3ed7fc039a ("eventdev: add extended stats")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>
> 

Applied to dpdk-next-eventdev/master. Thanks.

Patch
diff mbox series

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index d7eb69d1f..ef10a855d 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -1893,7 +1893,7 @@  rte_event_dev_xstats_names_get(uint8_t dev_id,
  * @param ids
  *   The id numbers of the stats to get. The ids can be got from the stat
  *   position in the stat list from rte_event_dev_get_xstats_names(), or
- *   by using rte_eventdev_get_xstats_by_name()
+ *   by using rte_event_dev_xstats_by_name_get().
  * @param[out] values
  *   The values for each stats request by ID.
  * @param n
@@ -1921,7 +1921,7 @@  rte_event_dev_xstats_get(uint8_t dev_id,
  *   The stat name to retrieve
  * @param[out] id
  *   If non-NULL, the numerical id of the stat will be returned, so that further
- *   requests for the stat can be got using rte_eventdev_xstats_get, which will
+ *   requests for the stat can be got using rte_event_dev_xstats_get, which will
  *   be faster as it doesn't need to scan a list of names for the stat.
  *   If the stat cannot be found, the id returned will be (unsigned)-1.
  * @return