From: Anatoly Burakov <anatoly.burakov@intel.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, liang.j.ma@intel.com, david.hunt@intel.com
Subject: [dpdk-dev] [PATCH] eal: fix incorrect API doc for power intrinsics
Date: Mon, 2 Nov 2020 12:57:36 +0000 [thread overview]
Message-ID: <57898fa9cf20b6b4a5c101a20874b7098a13edba.1604321851.git.anatoly.burakov@intel.com> (raw)
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
next reply other threads:[~2020-11-02 12:57 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-02 12:57 Anatoly Burakov [this message]
2020-11-03 10:00 ` Liang, Ma
2020-11-03 21:14 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=57898fa9cf20b6b4a5c101a20874b7098a13edba.1604321851.git.anatoly.burakov@intel.com \
--to=anatoly.burakov@intel.com \
--cc=david.hunt@intel.com \
--cc=dev@dpdk.org \
--cc=liang.j.ma@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).