[v2] doc: announce change in power API
Checks
Commit Message
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>
Reviewed-by: Rami Rosen <ramirose@gmail.com>
Acked-by: David Hunt <david.hunt@intel.com>
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/rel_notes/deprecation.rst | 5 +++++
1 file changed, 5 insertions(+)
Comments
13/05/2019 15:52, Hajkowski:
> 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>
> Reviewed-by: Rami Rosen <ramirose@gmail.com>
> Acked-by: David Hunt <david.hunt@intel.com>
> Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Applied, thanks
@@ -82,3 +82,8 @@ Deprecation Notices
* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
+
+* power: ``rte_power_set_env`` function will no longer return 0 on attempt
+ to set new power environment if power environment was already initialized.
+ In this case the function will return -1 unless the environment is unset first
+ (using ``rte_power_unset_env``). Other function usage scenarios will not change.