[dpdk-dev] [PATCH] doc: add meter API change to release notes

[dpdk-dev] [PATCH] doc: add meter API change to release notes

[Jasvinder Singh]

Update the release notes with meter api change to support configuration
profiles.

Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
---
 doc/guides/rel_notes/release_18_05.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
index e5fac1c..34222cd 100644
--- a/doc/guides/rel_notes/release_18_05.rst
+++ b/doc/guides/rel_notes/release_18_05.rst
@@ -72,6 +72,16 @@ API Changes
    Also, make sure to start the actual text at the margin.
    =========================================================
 
+* **Meter API updated to accomodate configuration profiles.**
+
+  The meter API is changed to support meter configuration profiles. The
+  configuration profile represents the set of configuration parameters
+  for a given meter object, such as the rates and sizes for the token
+  buckets. These configuration parameters were previously the part of meter
+  object internal data strcuture. The separation of the configuration
+  parameters from meter object data structure results in reducing its
+  memory footprint which helps in better cache utilization when large number
+  of meter objects are used.
 
 ABI Changes
 -----------
-- 
2.9.3

Re: [dpdk-dev] [PATCH] doc: add meter API change to release notes

[Dumitrescu, Cristian]

> -----Original Message-----
> From: Singh, Jasvinder
> Sent: Thursday, April 5, 2018 12:50 PM
> To: dev@dpdk.org
> Cc: Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Subject: [PATCH] doc: add meter API change to release notes
> 
> Update the release notes with meter api change to support configuration
> profiles.
> 
> Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
> ---
>  doc/guides/rel_notes/release_18_05.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_18_05.rst
> b/doc/guides/rel_notes/release_18_05.rst
> index e5fac1c..34222cd 100644
> --- a/doc/guides/rel_notes/release_18_05.rst
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -72,6 +72,16 @@ API Changes
>     Also, make sure to start the actual text at the margin.
>     =========================================================
> 
> +* **Meter API updated to accomodate configuration profiles.**
> +
> +  The meter API is changed to support meter configuration profiles. The
> +  configuration profile represents the set of configuration parameters
> +  for a given meter object, such as the rates and sizes for the token
> +  buckets. These configuration parameters were previously the part of
> meter
> +  object internal data strcuture. The separation of the configuration
> +  parameters from meter object data structure results in reducing its
> +  memory footprint which helps in better cache utilization when large
> number
> +  of meter objects are used.
> 
>  ABI Changes
>  -----------
> --
> 2.9.3

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Re: [dpdk-dev] [PATCH] doc: add meter API change to release notes

[Thomas Monjalon]

05/04/2018 14:03, Dumitrescu, Cristian:
> From: Singh, Jasvinder
> > 
> > Update the release notes with meter api change to support configuration
> > profiles.
> > 
> > Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
> > ---
> > --- a/doc/guides/rel_notes/release_18_05.rst
> > +++ b/doc/guides/rel_notes/release_18_05.rst
> > @@ -72,6 +72,16 @@ API Changes
> >     Also, make sure to start the actual text at the margin.
> >     =========================================================
> > 
> > +* **Meter API updated to accomodate configuration profiles.**
> > +
> > +  The meter API is changed to support meter configuration profiles. The
> > +  configuration profile represents the set of configuration parameters
> > +  for a given meter object, such as the rates and sizes for the token
> > +  buckets. These configuration parameters were previously the part of
> > meter
> > +  object internal data strcuture. The separation of the configuration
> > +  parameters from meter object data structure results in reducing its
> > +  memory footprint which helps in better cache utilization when large
> > number
> > +  of meter objects are used.
> 
> Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

Applied with a small formatting change:
	* meter: updated to accommodate configuration profiles.