diff mbox series

ethdev: Clarify usage of TM node parent update API function

Message ID 20180710153301.546-1-benjamin.h.shelton@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Cristian Dumitrescu
Headers show
Series ethdev: Clarify usage of TM node parent update API function | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Ben Shelton July 10, 2018, 3:33 p.m. UTC
The node parent update API function may be used to update the
priority/weight of an existing node.  Update the documentation to
indicate that this use case is supported.

Signed-off-by: Ben Shelton <benjamin.h.shelton@intel.com>
---
 lib/librte_ethdev/rte_tm.h | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Thomas Monjalon July 31, 2018, 3:05 p.m. UTC | #1
Cristian, review please?

10/07/2018 17:33, Ben Shelton:
> The node parent update API function may be used to update the
> priority/weight of an existing node.  Update the documentation to
> indicate that this use case is supported.
> 
> Signed-off-by: Ben Shelton <benjamin.h.shelton@intel.com>
[...]
>  /**
>   * Traffic manager node parent update
>   *
> + * This function may be used to move a node and its children to a different
> + * parent.  Additionally, if the new parent is the same as the current parent,
> + * this function will update the priority/weight of an existing node.
> + *
>   * Restriction for root node: its parent cannot be changed.
>   *
>   * This function can only be called after the rte_tm_hierarchy_commit()
Dumitrescu, Cristian July 31, 2018, 3:09 p.m. UTC | #2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Tuesday, July 31, 2018 4:06 PM
> To: Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Cc: dev@dpdk.org; Shelton, Benjamin H <benjamin.h.shelton@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] ethdev: Clarify usage of TM node parent
> update API function
> 
> Cristian, review please?
> 
> 10/07/2018 17:33, Ben Shelton:
> > The node parent update API function may be used to update the
> > priority/weight of an existing node.  Update the documentation to
> > indicate that this use case is supported.
> >
> > Signed-off-by: Ben Shelton <benjamin.h.shelton@intel.com>
> [...]
> >  /**
> >   * Traffic manager node parent update
> >   *
> > + * This function may be used to move a node and its children to a
> different
> > + * parent.  Additionally, if the new parent is the same as the current
> parent,
> > + * this function will update the priority/weight of an existing node.
> > + *
> >   * Restriction for root node: its parent cannot be changed.
> >   *
> >   * This function can only be called after the rte_tm_hierarchy_commit()
> 
> 
> 

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
Thomas Monjalon July 31, 2018, 4:52 p.m. UTC | #3
31/07/2018 17:09, Dumitrescu, Cristian:
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> > 
> > Cristian, review please?
> > 
> > 10/07/2018 17:33, Ben Shelton:
> > > The node parent update API function may be used to update the
> > > priority/weight of an existing node.  Update the documentation to
> > > indicate that this use case is supported.
> > >
> > > Signed-off-by: Ben Shelton <benjamin.h.shelton@intel.com>
> > [...]
> > >  /**
> > >   * Traffic manager node parent update
> > >   *
> > > + * This function may be used to move a node and its children to a
> > different
> > > + * parent.  Additionally, if the new parent is the same as the current
> > parent,
> > > + * this function will update the priority/weight of an existing node.
> > > + *
> > >   * Restriction for root node: its parent cannot be changed.
> > >   *
> > >   * This function can only be called after the rte_tm_hierarchy_commit()
> 
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/lib/librte_ethdev/rte_tm.h b/lib/librte_ethdev/rte_tm.h
index 7255403..955f02f 100644
--- a/lib/librte_ethdev/rte_tm.h
+++ b/lib/librte_ethdev/rte_tm.h
@@ -1569,6 +1569,10 @@  rte_tm_hierarchy_commit(uint16_t port_id,
 /**
  * Traffic manager node parent update
  *
+ * This function may be used to move a node and its children to a different
+ * parent.  Additionally, if the new parent is the same as the current parent,
+ * this function will update the priority/weight of an existing node.
+ *
  * Restriction for root node: its parent cannot be changed.
  *
  * This function can only be called after the rte_tm_hierarchy_commit()