[PATCH] doc: announce deprecation of cmdline_poll

[PATCH] doc: announce deprecation of cmdline_poll

[Stephen Hemminger]

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>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 872847e938ed..28c458591a68 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -135,3 +135,8 @@ Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   In the absence of such interest, this library will be removed in DPDK 23.11.
+
+* cmdline: The function ``cmdline_poll`` does not work correctly on either
+  Linux or Windows and is unused by any part of DPDK.
+  It will be marked deprecated
+  starting in the 23.07 relead and removed in DPDK 23.11.
-- 
2.39.2

Re: [PATCH] doc: announce deprecation of cmdline_poll

[Stephen Hemminger]

On Tue, 14 Mar 2023 10:18:58 -0700
Stephen Hemminger <stephen@networkplumber.org> wrote:

> 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>

FYI - checked and none of the DPDK projects on github are using this API.
I.e Vpp, yastack, Trex, ANS, BESS, conntrail, ...

Re: [PATCH] doc: announce deprecation of cmdline_poll

[Maxime Coquelin]

On 3/15/23 00:01, Stephen Hemminger wrote:
> On Tue, 14 Mar 2023 10:18:58 -0700
> Stephen Hemminger <stephen@networkplumber.org> wrote:
> 
>> 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>
> 
> FYI - checked and none of the DPDK projects on github are using this API.
> I.e Vpp, yastack, Trex, ANS, BESS, conntrail, ...
> 

I also checked and could not find any DPDK app using this API.

Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime

Re: [PATCH] doc: announce deprecation of cmdline_poll

[Stephen Hemminger]

On Tue, 14 Mar 2023 10:18:58 -0700
Stephen Hemminger <stephen@networkplumber.org> wrote:

> 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>
> ---
>  doc/guides/rel_notes/deprecation.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 872847e938ed..28c458591a68 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -135,3 +135,8 @@ Deprecation Notices
>    Its removal has been postponed to let potential users report interest
>    in maintaining it.
>    In the absence of such interest, this library will be removed in DPDK 23.11.
> +
> +* cmdline: The function ``cmdline_poll`` does not work correctly on either
> +  Linux or Windows and is unused by any part of DPDK.
> +  It will be marked deprecated
> +  starting in the 23.07 relead and removed in DPDK 23.11.

This patch was put out in March and should be merged for 23.07 so that
the dead function can be removed in 23.11.

Why the no response on this? The function was never used and if anyone did
try to use it would have discovered it was broken.

Should it just be removed in 23.11 without warning?

Re: [PATCH] doc: announce deprecation of cmdline_poll

[Thomas Monjalon]

26/06/2023 18:38, Stephen Hemminger:
> On Tue, 14 Mar 2023 10:18:58 -0700
> Stephen Hemminger <stephen@networkplumber.org> wrote:
> 
> > 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>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 872847e938ed..28c458591a68 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -135,3 +135,8 @@ Deprecation Notices
> >    Its removal has been postponed to let potential users report interest
> >    in maintaining it.
> >    In the absence of such interest, this library will be removed in DPDK 23.11.
> > +
> > +* cmdline: The function ``cmdline_poll`` does not work correctly on either
> > +  Linux or Windows and is unused by any part of DPDK.
> > +  It will be marked deprecated
> > +  starting in the 23.07 relead and removed in DPDK 23.11.

There is no patch to mark the function deprecated as far as I know.

> This patch was put out in March and should be merged for 23.07 so that
> the dead function can be removed in 23.11.
> 
> Why the no response on this? The function was never used and if anyone did
> try to use it would have discovered it was broken.

It would have helped to add few people in Cc list.

> Should it just be removed in 23.11 without warning?

We could take it with the Technical Board.

Re: [PATCH] doc: announce deprecation of cmdline_poll

[Bruce Richardson]

On Tue, Mar 14, 2023 at 10:18:58AM -0700, Stephen Hemminger wrote:
> 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>
> ---
>  doc/guides/rel_notes/deprecation.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 872847e938ed..28c458591a68 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -135,3 +135,8 @@ Deprecation Notices
>    Its removal has been postponed to let potential users report interest
>    in maintaining it.
>    In the absence of such interest, this library will be removed in DPDK 23.11.
> +
> +* cmdline: The function ``cmdline_poll`` does not work correctly on either
> +  Linux or Windows and is unused by any part of DPDK.
> +  It will be marked deprecated
> +  starting in the 23.07 relead and removed in DPDK 23.11.

typo: "release".

We also should ack a "deprecated" tag on the function to give build-time
warnings. Since we are in the middle of having patches merged, I'll spin a
v2 for you to save time.
> -- 
> 2.39.2
> 

[PATCH v2] doc: announce deprecation of cmdline_poll

[Bruce Richardson]

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);
-- 
2.39.2

Re: [PATCH v2] doc: announce deprecation of cmdline_poll

[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.
> ---
>   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

Re: [PATCH v2] doc: announce deprecation of cmdline_poll

[Thomas Monjalon]

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.

Re: [PATCH v2] doc: announce deprecation of cmdline_poll

[Burakov, Anatoly]

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>

-- 
Thanks,
Anatoly