doc: announce deprecation of cmdline_poll
PATCH 1/1 doc: announce deprecation of cmdline_poll
Function was added by commit 067855e651d6 ("cmdline: add polling mode") but never tested or used by DPDK applications. Mark it for future removal.
--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)
doc/guides/rel_notes/deprecation.rst +5 -0
@@ -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.
Signature · 1 line
2.39.2
Quoted 5 lines · On Tue, 14 Mar 2023 10:18:58 -0700 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 <[email protected]>
FYI - checked and none of the DPDK projects on github are using this API. I.e Vpp, yastack, Trex, ANS, BESS, conntrail, ...
Quoted 14 lines · On Tue, 14 Mar 2023 10:18:58 -0700 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 <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)doc/guides/rel_notes/deprecation.rst +0
-0
doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 142
Quoted 8 lines
doc/guides/rel_notes/deprecation.rst +5
-0@@ -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:
Quoted 12 lines
Quoted 9 lines · On Tue, 14 Mar 2023 10:18:58 -0700 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 <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)
Quoted 13 lines
doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 142
Quoted 13 lines
doc/guides/rel_notes/deprecation.rst +5
-0@@ -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.
Quoted 5 lines
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.
Quoted 1 line
Should it just be removed in 23.11 without warning?
We could take it with the Technical Board.
Quoted 14 lines · 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 <[email protected]>--- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+)doc/guides/rel_notes/deprecation.rst +0
-0
doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 142
Quoted 8 lines
doc/guides/rel_notes/deprecation.rst +5
-0@@ -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.
Quoted 3 lines
Signature · 1 line
2.39.2
Maxime Coquelin
Acked-byQuoted 12 lines · Stephen Hemminger
Quoted 5 lines · On Tue, 14 Mar 2023 10:18:58 -0700 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 <[email protected]>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.
Thanks,
Maxime
PATCH v2 1/1 doc: announce deprecation of cmdline_poll
In reply to Stephen HemmingerFrom: Stephen Hemminger <[email protected]>
Function was added by commit 067855e651d6 ("cmdline: add polling mode") but never tested or used by DPDK applications. Mark it for future removal.
---
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(+)
doc/guides/rel_notes/deprecation.rst +4 -0
@@ -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.
lib/cmdline/cmdline.h +3 -0
@@ -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);
Signature · 1 line
2.39.2
Quoted 42 lines · Bruce Richardson
From: Stephen Hemminger <[email protected]>
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 <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
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(+)doc/guides/rel_notes/deprecation.rst +4
-0@@ -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.lib/cmdline/cmdline.h +2
-0@@ -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.
lib/cmdline/cmdline.h cmdline_get_rdline(struct cmdline *cl); · line 63
Quoted 7 lines
lib/cmdline/cmdline.h +1
-0@@ -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:
Thanks,
Maxime
Quoted 6 lines · Bruce Richardson
From: Stephen Hemminger <[email protected]>
Function was added by commit
067855e651d6("cmdline: add polling mode") but never tested or used by DPDK applications. Mark it for future removal.
Quoted 6 lines
Signed-off-by Stephen Hemminger <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
v2: Add deprecated tag to function and doxygen comment.
---
Signature · 2 lines
Thanks, Anatoly
28/07/2023 12:26, Maxime Coquelin:
Quoted 8 lines · Bruce Richardson
Quoted 6 lines
From: Stephen Hemminger <[email protected]>
Function was added by commit
067855e651d6("cmdline: add polling mode") but never tested or used by DPDK applications. Mark it for future removal.
Quoted 8 lines
Quoted 6 lines
Signed-off-by Stephen Hemminger <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
v2: Add deprecated tag to function and doxygen comment.
---Acked-by Maxime Coquelin <[email protected]>
Applied, thanks.