diff mbox series

[v3] doc: add removal note for power empty poll API

Message ID 20221007134034.498762-1-reshma.pattan@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series [v3] doc: add removal note for power empty poll API | expand

Checks

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

Commit Message

Pattan, Reshma Oct. 7, 2022, 1:40 p.m. UTC
Add removal note 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 Oct. 31, 2022, 3:26 p.m. UTC | #1
07/10/2022 15:40, Reshma Pattan:
> --- a/doc/guides/prog_guide/power_man.rst
> +++ b/doc/guides/prog_guide/power_man.rst
> @@ -192,6 +192,14 @@ User Cases
>  ----------
>  The mechanism can applied to any device which is based on polling. e.g. NIC, FPGA.
>  
> +
> +Removal Note
> +------------
> +
> +The experimental empty poll APIs will be removed from the library in a future
> +DPDK release.

After more thoughts, I think it would be better highlighted if moved
at the beginning of the section "Empty Poll API".
It could a note block or a warning.

Also, could we explain how it is replaced?
Pattan, Reshma Nov. 2, 2022, 12:35 p.m. UTC | #2
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
<snip>
> > +Removal Note
> > +------------
> > +
> > +The experimental empty poll APIs will be removed from the library in
> > +a future DPDK release.
> 
> After more thoughts, I think it would be better highlighted if moved at the
> beginning of the section "Empty Poll API".
> It could a note block or a warning.
> 
> Also, could we explain how it is replaced?
> 

The empty poll API will be removed completely,  because dpdk now has power pmd modes i.e. monitor, scale and pause which can be used for power saving over empty poll API.

V4 is sent now.
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index 98cfd3c1f3..3b0c3373a1 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -192,6 +192,14 @@  User Cases
 ----------
 The mechanism can applied to any device which is based on polling. e.g. NIC, FPGA.
 
+
+Removal Note
+------------
+
+The experimental empty poll APIs will be removed from the library in a future
+DPDK release.
+
+
 Ethernet PMD Power Management API
 ---------------------------------