doc: announce deprecation of cmdline_poll
Checks
Commit Message
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(+)
Comments
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, ...
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?
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.
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
>
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
@@ -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.