diff mbox series

doc: add removal note for power empty poll API

Message ID 20220802152206.1210365-1-reshma.pattan@intel.com (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers show
Series doc: add removal note for power empty poll API | expand

Checks

Context Check Description
ci/github-robot: build success github build: passed
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/intel-Testing success Testing PASS
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/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Pattan, Reshma Aug. 2, 2022, 3:22 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>
---
 doc/guides/prog_guide/power_man.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Hunt, David Aug. 30, 2022, 9:23 a.m. UTC | #1
On 02/08/2022 16:22, Reshma Pattan wrote:
> Add removal note for experimental empty poll API.
>
> CC: David Hunt <david.hunt@intel.com>
>
> Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
> ---
>   doc/guides/prog_guide/power_man.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
> index 98cfd3c1f3..2e47d87cbb 100644
> --- a/doc/guides/prog_guide/power_man.rst
> +++ b/doc/guides/prog_guide/power_man.rst
> @@ -192,6 +192,12 @@ 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.
> +Suggest to use new lcore poll busyness APIs added in 22.11.
> +
> +
>   Ethernet PMD Power Management API
>   ---------------------------------
>   

Hi Reshma,

Yes, these APIs will be superseded by the newer poll busyness telemetry.

Acked-by: David Hunt <david.hunt@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/power_man.rst b/doc/guides/prog_guide/power_man.rst
index 98cfd3c1f3..2e47d87cbb 100644
--- a/doc/guides/prog_guide/power_man.rst
+++ b/doc/guides/prog_guide/power_man.rst
@@ -192,6 +192,12 @@  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.
+Suggest to use new lcore poll busyness APIs added in 22.11.
+
+
 Ethernet PMD Power Management API
 ---------------------------------