[v4] lib/power: remove set env deprecation notice
diff mbox series

Message ID 20201027132413.23116-1-david.hunt@intel.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [v4] lib/power: remove set env deprecation notice
Related show

Checks

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

Commit Message

David Hunt Oct. 27, 2020, 1:24 p.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>

---

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

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 verion. I didn't add a Fixes line to this patch as I believe
the notice was correct, just adding both fix and notice in the same version
was not strictly the right thing to have done at the time.
---
 doc/guides/rel_notes/deprecation.rst | 5 -----
 1 file changed, 5 deletions(-)

Comments

Thomas Monjalon Nov. 3, 2020, 8:46 p.m. UTC | #1
27/10/2020 14:24, 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>
> 
> ---
> 
> 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
> 
> 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 verion. I didn't add a Fixes line to this patch as I believe
> the notice was correct, just adding both fix and notice in the same version
> was not strictly the right thing to have done at the time.

The Fixes: line must reference the commit which did the API change
without removing the notice.

Cc: stable@dpdk.org must be below the Fixes line.

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 76a83968c..ed82df52a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -172,11 +172,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.