[v2] doc: announce deprecation of cmdline_poll
Checks
Commit Message
From: Stephen Hemminger <stephen@networkplumber.org>
Function was added by commit 067855e651d6 ("cmdline: add polling mode")
but never tested or used by DPDK applications. Mark it for
future removal.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
v2: Add deprecated tag to function and doxygen comment.
---
doc/guides/rel_notes/deprecation.rst | 4 ++++
lib/cmdline/cmdline.h | 3 +++
2 files changed, 7 insertions(+)
Comments
On 7/28/23 12:15, Bruce Richardson wrote:
> From: Stephen Hemminger <stephen@networkplumber.org>
>
> Function was added by commit 067855e651d6 ("cmdline: add polling mode")
> but never tested or used by DPDK applications. Mark it for
> future removal.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>
> ---
> v2: Add deprecated tag to function and doxygen comment.
> ---
> doc/guides/rel_notes/deprecation.rst | 4 ++++
> lib/cmdline/cmdline.h | 3 +++
> 2 files changed, 7 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index fb771a0305..78d56a0ab4 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -161,3 +161,7 @@ Deprecation Notices
> The new port library API (functions rte_swx_port_*)
> will gradually transition from experimental to stable status
> starting with DPDK 23.07 release.
> +
> +* cmdline: The function ``cmdline_poll`` does not work correctly on either
> + Linux or Windows and is unused by any part of DPDK.
> + This function is now deprecated and will be removed in DPDK 23.11.
> diff --git a/lib/cmdline/cmdline.h b/lib/cmdline/cmdline.h
> index b14355ef51..52c89b48bc 100644
> --- a/lib/cmdline/cmdline.h
> +++ b/lib/cmdline/cmdline.h
> @@ -44,6 +44,8 @@ struct rdline *
> cmdline_get_rdline(struct cmdline *cl);
>
> /**
> + * @deprecated Function is broken and scheduled for removal
> + *
> * This function is nonblocking equivalent of ``cmdline_interact()``. It polls
> * *cl* for one character and interpret it. If return value is *RDLINE_EXITED*
> * it mean that ``cmdline_quit()`` was invoked.
> @@ -55,6 +57,7 @@ cmdline_get_rdline(struct cmdline *cl);
> * On success return object status - one of *enum rdline_status*.
> * On error return negative value.
> */
> +__rte_deprecated
> int cmdline_poll(struct cmdline *cl);
>
> void cmdline_interact(struct cmdline *cl);
Reporting the ack I just provided on v1:
Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Thanks,
Maxime
On 7/28/2023 11:15 AM, Bruce Richardson wrote:
> From: Stephen Hemminger <stephen@networkplumber.org>
>
> Function was added by commit 067855e651d6 ("cmdline: add polling mode")
> but never tested or used by DPDK applications. Mark it for
> future removal.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>
> ---
> v2: Add deprecated tag to function and doxygen comment.
> ---
Acked-by: Anatoly Burakov <anatoly.burakov@intel.com>
28/07/2023 12:26, Maxime Coquelin:
>
> On 7/28/23 12:15, Bruce Richardson wrote:
> > From: Stephen Hemminger <stephen@networkplumber.org>
> >
> > Function was added by commit 067855e651d6 ("cmdline: add polling mode")
> > but never tested or used by DPDK applications. Mark it for
> > future removal.
> >
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> >
> > ---
> > v2: Add deprecated tag to function and doxygen comment.
> > ---
>
> Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
Applied, thanks.
@@ -161,3 +161,7 @@ Deprecation Notices
The new port library API (functions rte_swx_port_*)
will gradually transition from experimental to stable status
starting with DPDK 23.07 release.
+
+* cmdline: The function ``cmdline_poll`` does not work correctly on either
+ Linux or Windows and is unused by any part of DPDK.
+ This function is now deprecated and will be removed in DPDK 23.11.
@@ -44,6 +44,8 @@ struct rdline *
cmdline_get_rdline(struct cmdline *cl);
/**
+ * @deprecated Function is broken and scheduled for removal
+ *
* This function is nonblocking equivalent of ``cmdline_interact()``. It polls
* *cl* for one character and interpret it. If return value is *RDLINE_EXITED*
* it mean that ``cmdline_quit()`` was invoked.
@@ -55,6 +57,7 @@ cmdline_get_rdline(struct cmdline *cl);
* On success return object status - one of *enum rdline_status*.
* On error return negative value.
*/
+__rte_deprecated
int cmdline_poll(struct cmdline *cl);
void cmdline_interact(struct cmdline *cl);