doc: deprecate graph data structures

Message ID 20240221161319.7054-1-pbhagavatula@marvell.com (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series doc: deprecate graph data structures |

Checks

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

Commit Message

Pavan Nikhilesh Bhagavatula Feb. 21, 2024, 4:13 p.m. UTC
  From: Pavan Nikhilesh <pbhagavatula@marvell.com>

Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
structures as will be extended to include node specific error counters
and error description.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Jerin Jacob March 19, 2024, 3:22 a.m. UTC | #1
On Wed, Feb 21, 2024 at 9:43 PM <pbhagavatula@marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
>
> Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
> structures as will be extended to include node specific error counters
> and error description.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>

Implementation patches for 24.11 at
https://patches.dpdk.org/project/dpdk/list/?series=31181.
The deprecation notice looks good to me.

Acked-by: Jerin Jacob <jerinj@marvell.com>




> ---
>  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 10630ba255..b3dfd06ed6 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -142,3 +142,8 @@ Deprecation Notices
>    will be deprecated and subsequently removed in DPDK 24.11 release.
>    Before this, the new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status.
> +
> +* graph: The graph library data structures will be modified to
> +  support node specific errors, the structures ``rte_node``,
> +  ``rte_node_register`` and ``rte_graph_cluster_node_stats`` will be
> +  extended to include node error counters and error description.
> --
> 2.25.1
>
  
Nithin Dabilpuram March 19, 2024, 5:21 a.m. UTC | #2
Acked-by: Nithin Dabilpuram <ndabilpuram@marvell.com>

On Wed, Feb 21, 2024 at 9:50 PM <pbhagavatula@marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
>
> Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
> structures as will be extended to include node specific error counters
> and error description.
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> ---
>  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 10630ba255..b3dfd06ed6 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -142,3 +142,8 @@ Deprecation Notices
>    will be deprecated and subsequently removed in DPDK 24.11 release.
>    Before this, the new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status.
> +
> +* graph: The graph library data structures will be modified to
> +  support node specific errors, the structures ``rte_node``,
> +  ``rte_node_register`` and ``rte_graph_cluster_node_stats`` will be
> +  extended to include node error counters and error description.
> --
> 2.25.1
>
  
Stephen Hemminger March 19, 2024, 3:50 p.m. UTC | #3
On Tue, 19 Mar 2024 08:52:13 +0530
Jerin Jacob <jerinjacobk@gmail.com> wrote:

> On Wed, Feb 21, 2024 at 9:43 PM <pbhagavatula@marvell.com> wrote:
> >
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
> > structures as will be extended to include node specific error counters
> > and error description.
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>  
> 
> Implementation patches for 24.11 at
> https://patches.dpdk.org/project/dpdk/list/?series=31181.
> The deprecation notice looks good to me.
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Can more of the internals be private to the library to avoid future changes.
  
Yan, Zhirun March 20, 2024, 3:07 a.m. UTC | #4
Acked-by: Zhirun Yan <zhirun.yan@intel.com>

> -----Original Message-----
> From: Nithin Dabilpuram <nithind1988@gmail.com>
> Sent: Tuesday, March 19, 2024 1:21 PM
> To: pbhagavatula@marvell.com
> Cc: jerinj@marvell.com; ndabilpuram@marvell.com; kirankumark@marvell.com;
> Yan, Zhirun <zhirun.yan@intel.com>; dev@dpdk.org
> Subject: Re: [PATCH] doc: deprecate graph data structures
> 
> Acked-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> 
> On Wed, Feb 21, 2024 at 9:50 PM <pbhagavatula@marvell.com> wrote:
> >
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
> > structures as will be extended to include node specific error counters
> > and error description.
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > ---
> >  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 10630ba255..b3dfd06ed6 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -142,3 +142,8 @@ Deprecation Notices
> >    will be deprecated and subsequently removed in DPDK 24.11 release.
> >    Before this, the new port library API (functions rte_swx_port_*)
> >    will gradually transition from experimental to stable status.
> > +
> > +* graph: The graph library data structures will be modified to
> > +  support node specific errors, the structures ``rte_node``,
> > +  ``rte_node_register`` and ``rte_graph_cluster_node_stats`` will be
> > +  extended to include node error counters and error description.
> > --
> > 2.25.1
> >
  
Pavan Nikhilesh Bhagavatula March 20, 2024, 7:29 a.m. UTC | #5
> On Tue, 19 Mar 2024 08:52:13 +0530
> Jerin Jacob <jerinjacobk@gmail.com> wrote:
> 
> > On Wed, Feb 21, 2024 at 9:43 PM <pbhagavatula@marvell.com> wrote:
> > >
> > > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > >
> > > Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
> > > structures as will be extended to include node specific error counters
> > > and error description.
> > >
> > > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > Implementation patches for 24.11 at
> > https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__patches.dpdk.org_project_dpdk_list_-3Fseries-
> 3D31181&d=DwIFaQ&c=nKjWec2b6R0mOyPaz7xtfQ&r=E3SgYMjtKCMVsB-
> fmvgGV3o-g_fjLhk5Pupi9ijohpc&m=UWUO-
> vO43HDzAb_QlsOvuvJsc8rbmtFAcsB6Hgzhjaumo01L-
> tlXha8dw_qPzxMO&s=FKKIPKTNhxdMKJf9M4Gma8F4783JsEFR512A7hfeQp
> g&e= .
> > The deprecation notice looks good to me.
> >
> > Acked-by: Jerin Jacob <jerinj@marvell.com>
> 
> Can more of the internals be private to the library to avoid future changes.

These structures are all used in fastpath i.e., inline functions so, unfortunately
cant be made private.
  
Pavan Nikhilesh Bhagavatula July 18, 2024, 12:36 p.m. UTC | #6
Thomas, 

Ping can this deprecation notice be merged


> Acked-by: Zhirun Yan <zhirun.yan@intel.com>
> 
> > -----Original Message-----
> > From: Nithin Dabilpuram <nithind1988@gmail.com>
> > Sent: Tuesday, March 19, 2024 1:21 PM
> > To: pbhagavatula@marvell.com
> > Cc: jerinj@marvell.com; ndabilpuram@marvell.com;
> kirankumark@marvell.com;
> > Yan, Zhirun <zhirun.yan@intel.com>; dev@dpdk.org
> > Subject: Re: [PATCH] doc: deprecate graph data structures
> >
> > Acked-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> >
> > On Wed, Feb 21, 2024 at 9:50 PM <pbhagavatula@marvell.com> wrote:
> > >
> > > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > >
> > > Deprecate rte_node, rte_node_register and rte_graph_cluster_node_stats
> > > structures as will be extended to include node specific error counters
> > > and error description.
> > >
> > > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > > ---
> > >  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 10630ba255..b3dfd06ed6 100644
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > @@ -142,3 +142,8 @@ Deprecation Notices
> > >    will be deprecated and subsequently removed in DPDK 24.11 release.
> > >    Before this, the new port library API (functions rte_swx_port_*)
> > >    will gradually transition from experimental to stable status.
> > > +
> > > +* graph: The graph library data structures will be modified to
> > > +  support node specific errors, the structures ``rte_node``,
> > > +  ``rte_node_register`` and ``rte_graph_cluster_node_stats`` will be
> > > +  extended to include node error counters and error description.
> > > --
> > > 2.25.1
> > >
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 10630ba255..b3dfd06ed6 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -142,3 +142,8 @@  Deprecation Notices
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status.
+
+* graph: The graph library data structures will be modified to
+  support node specific errors, the structures ``rte_node``,
+  ``rte_node_register`` and ``rte_graph_cluster_node_stats`` will be
+  extended to include node error counters and error description.