diff mbox series

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

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

Checks

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

Commit Message

Pattan, Reshma Oct. 5, 2022, 8:44 a.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 | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Thomas Monjalon Oct. 5, 2022, 12:27 p.m. UTC | #1 
05/10/2022 10:44, Reshma Pattan:
> 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>
[...]
> --- 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.

It looks common in this file to forget the empty line after a title,
but please don't forget it.

I am surprised Sphinx is not complaining.
Pattan, Reshma Oct. 7, 2022, 1:54 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.
> 
> It looks common in this file to forget the empty line after a title, but please
> don't forget it.
> 

Good catch, this is addressed in v3 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..9a40242dd0 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.
+
+
 Ethernet PMD Power Management API
 ---------------------------------