[1/1] doc: announce change in power API

Message ID 20190313192107.696-1-marcinx.hajkowski@intel.com
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • [1/1] doc: announce change in power API
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Hajkowski March 13, 2019, 7:21 p.m.
From: Marcin Hajkowski <marcinx.hajkowski@intel.com>

Function rte_power_set_env will no longer return
success on attempt to set env in initialized state.

Signed-off-by: Marcin Hajkowski <marcinx.hajkowski@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Rami Rosen March 14, 2019, 6:50 p.m. | #1
Hajkowski ‏<marcinx.hajkowski@intel.com>:

> From: Marcin Hajkowski <marcinx.hajkowski@intel.com>
>
> Function rte_power_set_env will no longer return
> success on attempt to set env in initialized state.
>
> Signed-off-by: Marcin Hajkowski <marcinx.hajkowski@intel.com>
> ---
>

For further patches, please remove the legal disclaimer at the bottom.

Reviewed-by: Rami Rosen <ramirose@gmail.com>

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1b4fcb7e6..7899e6874 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -75,3 +75,8 @@  Deprecation Notices
 
 * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
   changed from 0.49.0 to 0.52.0.
+
+* power: ``rte_power_set_env`` function will no longer return 0 on attempt
+  to set new power environment if power environment was already initialized.
+  Instead, the function will return -1 unless the environment is unset first
+  (using ``rte_power_unset_env``).