[v3] doc: add removal note for power empty poll API
Checks
Commit Message
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
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?
> -----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.
@@ -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
---------------------------------