[v5] lib/power: remove set env deprecation notice

Message ID 20201104092810.29135-1-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v5] lib/power: remove set env deprecation notice |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Hunt, David Nov. 4, 2020, 9:28 a.m. UTC
  Remove notice announcing an already-implemented change.

In 19.05, rte_power_set_env was changed to return -1 in cases where
the envorinment was already set up, and for the same release, a
deprecation notice was added for the following commit:
'commit 5a5f3178d4a8 ("power: return error when environment already set")'
This patch removes that notice.

The API change was tested by calling rte_power_set_env twice. The first
call succeeded, and the second call failed, as expected.

Signed-off-by: David Hunt <david.hunt@intel.com>
Fixes: 5a5f3178d4a8 ("power: return error when environment already set")
CC: stable@dpdk.org

---
v1 initial version (with typo in the title)
v2 fix typo but forgot --in-reply-to
v3 add -in-reply-to
v4 add in version info, and cc stable in case it needs to be backported
v5 add in Fixes line.

Note: CC'ing stable in case the deprecation notice should also be removed
from 19.11. It looks to me like the patch making the change and the patch
adding the notice were both added in 19.11, so the notice is no longer
needed in that version.
---
---
 doc/guides/rel_notes/deprecation.rst | 5 -----
 1 file changed, 5 deletions(-)
  

Comments

Thomas Monjalon Nov. 4, 2020, 8:10 p.m. UTC | #1
04/11/2020 10:28, David Hunt:
> Remove notice announcing an already-implemented change.
> 
> In 19.05, rte_power_set_env was changed to return -1 in cases where
> the envorinment was already set up, and for the same release, a
> deprecation notice was added for the following commit:
> 'commit 5a5f3178d4a8 ("power: return error when environment already set")'
> This patch removes that notice.
> 
> The API change was tested by calling rte_power_set_env twice. The first
> call succeeded, and the second call failed, as expected.
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>
> Fixes: 5a5f3178d4a8 ("power: return error when environment already set")
> CC: stable@dpdk.org

Re-arranged, title reworded and applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 43e0e09be..7e40f2d72 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -141,11 +141,6 @@  Deprecation Notices
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.
 
-* 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.
-
 * cmdline: ``cmdline`` structure will be made opaque to hide platform-specific
   content. On Linux and FreeBSD, supported prior to DPDK 20.11,
   original structure will be kept until DPDK 21.11.