[dpdk-dev,v4,2/2] doc: Update ABI Change for rte_eth_stats_reset

Message ID 20170810132952.26974-2-dharton@cisco.com (mailing list archive)
State Superseded, archived
Headers

Checks

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

Commit Message

David Harton Aug. 10, 2017, 1:29 p.m. UTC
  Signed-off-by: David Harton <dharton@cisco.com>
---

v4:
* Added requested release note about ABI change.

 doc/guides/rel_notes/release_17_11.rst | 1 +
 1 file changed, 1 insertion(+)
  

Comments

Thomas Monjalon Aug. 31, 2017, 10:10 p.m. UTC | #1
10/08/2017 15:29, David Harton:
> --- a/doc/guides/rel_notes/release_17_11.rst
> +++ b/doc/guides/rel_notes/release_17_11.rst
> @@ -124,6 +124,7 @@ ABI Changes
>     Also, make sure to start the actual text at the margin.
>     =========================================================
>  
> +* Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``.

It should be documented in API changes section (not ABI).
  
Thomas Monjalon Aug. 31, 2017, 10:10 p.m. UTC | #2
01/09/2017 00:10, Thomas Monjalon:
> 10/08/2017 15:29, David Harton:
> > --- a/doc/guides/rel_notes/release_17_11.rst
> > +++ b/doc/guides/rel_notes/release_17_11.rst
> > @@ -124,6 +124,7 @@ ABI Changes
> >     Also, make sure to start the actual text at the margin.
> >     =========================================================
> >  
> > +* Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``.
> 
> It should be documented in API changes section (not ABI).

And it can be squashed with the first patch :)
  

Patch

diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst
index 170f4f9..e329f8a 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -124,6 +124,7 @@  ABI Changes
    Also, make sure to start the actual text at the margin.
    =========================================================
 
+* Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int``.
 
 
 Shared Library Versions