diff mbox series

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

Message ID 20221102123159.207613-1-reshma.pattan@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v4] 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/intel-Testing success Testing PASS

Commit Message

Pattan, Reshma Nov. 2, 2022, 12:31 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 | 9 +++++++++
 1 file changed, 9 insertions(+)
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index daad4d644d..88029bd079 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
 ~~~~~~~~
 
@@ -192,6 +200,7 @@  User Cases
 ----------
 The mechanism can applied to any device which is based on polling. e.g. NIC, FPGA.
 
+
 Ethernet PMD Power Management API
 ---------------------------------