eal: improve power monitor API comments
authorAnatoly Burakov <anatoly.burakov@intel.com>
Fri, 22 Jan 2021 17:12:15 +0000 (17:12 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Fri, 29 Jan 2021 14:29:48 +0000 (15:29 +0100)
commitabc0cade20f09f12f7c57c238306e8d730a10bb7
treebe4d10fa9001f74fd61203704d42205bfcfc5b7e
parentf400ea0b4cbf07d8538c5d18c054e198772fe354
eal: improve power monitor API comments

Currently, the API documentation is ambiguous as to what happens when
certain conditions are met. Document the behavior explicitly, as well as
fix some typos and outdated comments.

Fixes: 6a17919b0e2a ("eal: change power intrinsics API")

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
lib/librte_eal/include/generic/rte_power_intrinsics.h