[v10,4/4] eal: deprecation notice for rte thread setname API

Message ID 1674583941-16964-5-git-send-email-roretzla@linux.microsoft.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series add rte_thread_set_name API for rte_thread_t |

Checks

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

Commit Message

Tyler Retzlaff Jan. 24, 2023, 6:12 p.m. UTC
  Notify deprecation of rte_thread_setname API, it will be removed as it
exposes platform-specific thread details. The functionality it provided
is now available via the new rte_lcore_set_name API.

Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Thomas Monjalon Jan. 30, 2023, 3:46 p.m. UTC | #1
Hi,

The title should start with a verb.
I suppose it can be fixed while merging with a title like:
doc: announce deprecation of thread naming function


24/01/2023 19:12, Tyler Retzlaff:
> Notify deprecation of rte_thread_setname API, it will be removed as it
> exposes platform-specific thread details. The functionality it provided
> is now available via the new rte_lcore_set_name API.
> 
> Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
> Acked-by: Morten Brørup <mb@smartsharesystems.com>
> Acked-by: David Marchand <david.marchand@redhat.com>
> ---
> +* eal: The function ``rte_thread_setname`` is planned to be deprecated
> +  starting with the 23.07 release subject to the replacement API
> +  rte_thread_set_name being marked as stable and planned to be removed
> +  by the 23.11 release.

Minor: it would be clearer if adding some commas after "release" and "stable".


For the series,
Acked-by: Thomas Monjalon <thomas@monjalon.net>
  
David Marchand Jan. 30, 2023, 4:19 p.m. UTC | #2
On Mon, Jan 30, 2023 at 4:47 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> Hi,
>
> The title should start with a verb.
> I suppose it can be fixed while merging with a title like:
> doc: announce deprecation of thread naming function

Yes, I will handle it.

> 24/01/2023 19:12, Tyler Retzlaff:
> > Notify deprecation of rte_thread_setname API, it will be removed as it
> > exposes platform-specific thread details. The functionality it provided
> > is now available via the new rte_lcore_set_name API.
> >
> > Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
> > Acked-by: Morten Brørup <mb@smartsharesystems.com>
> > Acked-by: David Marchand <david.marchand@redhat.com>
> > ---
> > +* eal: The function ``rte_thread_setname`` is planned to be deprecated
> > +  starting with the 23.07 release subject to the replacement API
> > +  rte_thread_set_name being marked as stable and planned to be removed
> > +  by the 23.11 release.
>
> Minor: it would be clearer if adding some commas after "release" and "stable".

And this too.

>
>
> For the series,
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Thanks.
  
Tyler Retzlaff Jan. 30, 2023, 8:34 p.m. UTC | #3
On Mon, Jan 30, 2023 at 05:19:20PM +0100, David Marchand wrote:
> On Mon, Jan 30, 2023 at 4:47 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > Hi,
> >
> > The title should start with a verb.
> > I suppose it can be fixed while merging with a title like:
> > doc: announce deprecation of thread naming function
> 
> Yes, I will handle it.
> 
> > 24/01/2023 19:12, Tyler Retzlaff:
> > > Notify deprecation of rte_thread_setname API, it will be removed as it
> > > exposes platform-specific thread details. The functionality it provided
> > > is now available via the new rte_lcore_set_name API.
> > >
> > > Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
> > > Acked-by: Morten Brørup <mb@smartsharesystems.com>
> > > Acked-by: David Marchand <david.marchand@redhat.com>
> > > ---
> > > +* eal: The function ``rte_thread_setname`` is planned to be deprecated
> > > +  starting with the 23.07 release subject to the replacement API
> > > +  rte_thread_set_name being marked as stable and planned to be removed
> > > +  by the 23.11 release.
> >
> > Minor: it would be clearer if adding some commas after "release" and "stable".
> 
> And this too.
> 
> >
> >
> > For the series,
> > Acked-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Thanks.

thank you both, i'll rebase the rte_ctrl_thread_create patch series once
this is merged to get it moving forward again.
  
David Marchand Jan. 31, 2023, 9:53 a.m. UTC | #4
On Mon, Jan 30, 2023 at 9:35 PM Tyler Retzlaff
<roretzla@linux.microsoft.com> wrote:
> thank you both, i'll rebase the rte_ctrl_thread_create patch series once
> this is merged to get it moving forward again.
>

We are missing a reference to rte_thread.h in doc/api/doxy-api-index.md.
Please, can you send a patch for this too?

Thanks.
  
Tyler Retzlaff Jan. 31, 2023, 5:09 p.m. UTC | #5
On Tue, Jan 31, 2023 at 10:53:17AM +0100, David Marchand wrote:
> On Mon, Jan 30, 2023 at 9:35 PM Tyler Retzlaff
> <roretzla@linux.microsoft.com> wrote:
> > thank you both, i'll rebase the rte_ctrl_thread_create patch series once
> > this is merged to get it moving forward again.
> >
> 
> We are missing a reference to rte_thread.h in doc/api/doxy-api-index.md.
> Please, can you send a patch for this too?

no problem.

> 
> Thanks.
> 
> 
> -- 
> David Marchand
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index e18ac34..bae7441 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -18,6 +18,11 @@  Deprecation Notices
   in the future. Applications can use ``devtools/cocci/func_or_ret.cocci``
   to update their code.
 
+* eal: The function ``rte_thread_setname`` is planned to be deprecated
+  starting with the 23.07 release subject to the replacement API
+  rte_thread_set_name being marked as stable and planned to be removed
+  by the 23.11 release.
+
 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
   not allow for writing optimized code for all the CPU architectures supported
   in DPDK. DPDK has adopted the atomic operations from