diff mbox series

eal: fix incorrect API doc for power intrinsics

Message ID 57898fa9cf20b6b4a5c101a20874b7098a13edba.1604321851.git.anatoly.burakov@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers show
Series eal: fix incorrect API doc for power intrinsics | expand

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/travis-robot success Travis build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/checkpatch success coding style OK

Commit Message

Burakov, Anatoly Nov. 2, 2020, 12:57 p.m. UTC
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(-)

Comments

Liang, Ma Nov. 3, 2020, 10 a.m. UTC | #1
On 02 Nov 12:57, Anatoly Burakov wrote:
> 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>
Acked-by: Liang Ma <liang.j.ma@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
David Marchand Nov. 3, 2020, 9:14 p.m. UTC | #2
On Tue, Nov 3, 2020 at 11:01 AM Liang, Ma <liang.j.ma@intel.com> wrote:
>
> On 02 Nov 12:57, Anatoly Burakov wrote:
> > 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")
> >
Reported-by: David Marchand <david.marchand@redhat.com>
> > Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> Acked-by: Liang Ma <liang.j.ma@intel.com>

Applied.
diff mbox series

Patch

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