[v5] doc: add removal warning for power empty poll API

Message ID 20221102124118.207858-1-reshma.pattan@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v5] doc: add removal warning for power empty poll API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed

Commit Message

Pattan, Reshma Nov. 2, 2022, 12:41 p.m. UTC
  Add removal warning for experimental empty poll API.

CC: David Hunt <david.hunt@intel.com>

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
Acked-by: David Hunt <david.hunt@intel.com>
---
 doc/guides/prog_guide/power_man.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

Thomas Monjalon Nov. 15, 2022, 3:35 p.m. UTC | #1
02/11/2022 13:41, Reshma Pattan:
> Add removal warning for experimental empty poll API.
> 
> CC: David Hunt <david.hunt@intel.com>
> 
> Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
> Acked-by: David Hunt <david.hunt@intel.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index daad4d644d..0898426fba 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -110,6 +110,14 @@  The power management mechanism is used to save power when performing L3 forwardi
 Empty Poll API
 --------------
 
+Removal Warning
+~~~~~~~~~~~~~~~
+
+The experimental empty poll APIs will be removed from the library in a future
+DPDK release. The empty poll mechanism is superseded by the power pmd modes
+i.e. monitor, pause and scale.
+
+
 Abstract
 ~~~~~~~~