DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] eal: fix incorrect API doc for power intrinsics
@ 2020-11-02 12:57 Anatoly Burakov
  2020-11-03 10:00 ` Liang, Ma
  0 siblings, 1 reply; 3+ messages in thread
From: Anatoly Burakov @ 2020-11-02 12:57 UTC (permalink / raw)
  To: dev; +Cc: thomas, liang.j.ma, david.hunt

Currently, the intrinsics documentation refers to `rte_cpu_get_features`
as a check for whether these intrinsics are supported at runtime. This
is incorrect, because actually the user should use the
`rte_cpu_get_intrinsics_support` API to do said check. Fix the typo.

Fixes: 128021421256 ("eal: add intrinsics support check infrastructure")
Cc: liang.j.ma@intel.com

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 lib/librte_eal/include/generic/rte_power_intrinsics.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lib/librte_eal/include/generic/rte_power_intrinsics.h b/lib/librte_eal/include/generic/rte_power_intrinsics.h
index 9622c7f9ce..dd520d90fa 100644
--- a/lib/librte_eal/include/generic/rte_power_intrinsics.h
+++ b/lib/librte_eal/include/generic/rte_power_intrinsics.h
@@ -33,7 +33,7 @@
  * optimized power state may be aborted.
  *
  * @warning It is responsibility of the user to check if this function is
- *   supported at runtime using `rte_cpu_get_features()` API call.
+ *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  *   Failing to do so may result in an illegal CPU instruction error.
  *
  * @param p
@@ -74,7 +74,7 @@ static inline void rte_power_monitor(const volatile void *p,
  * waking up the CPU.
  *
  * @warning It is responsibility of the user to check if this function is
- *   supported at runtime using `rte_cpu_get_features()` API call.
+ *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  *   Failing to do so may result in an illegal CPU instruction error.
  *
  * @param p
@@ -110,7 +110,7 @@ static inline void rte_power_monitor_sync(const volatile void *p,
  * timestamp is reached.
  *
  * @warning It is responsibility of the user to check if this function is
- *   supported at runtime using `rte_cpu_get_features()` API call.
+ *   supported at runtime using `rte_cpu_get_intrinsics_support()` API call.
  *   Failing to do so may result in an illegal CPU instruction error.
  *
  * @param tsc_timestamp
-- 
2.17.1

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-11-03 21:15 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-02 12:57 [dpdk-dev] [PATCH] eal: fix incorrect API doc for power intrinsics Anatoly Burakov
2020-11-03 10:00 ` Liang, Ma
2020-11-03 21:14   ` David Marchand

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).