doc: announce API change for extended stats
authorHarry van Haaren <harry.van.haaren@intel.com>
Tue, 5 Apr 2016 17:58:09 +0000 (18:58 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Thu, 7 Apr 2016 21:36:56 +0000 (23:36 +0200)
This patch adds a notice that the API for the xstats
functionality will be modified in the 16.07 release, with
no backwards compatibility planned as it would require
code duplication in each PMD that supports xstats.

Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
Acked-by: Remy Horton <remy.horton@intel.com>
Acked-by: David Harton <dharton@cisco.com>
Acked-by: Maryam Tahhan <maryam.tahhan@intel.com>
doc/guides/rel_notes/deprecation.rst

index e49d9df..4bdde69 100644 (file)
@@ -25,6 +25,11 @@ Deprecation Notices
   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
 
+* The xstats API and rte_eth_xstats struct will be changed to allow retrieval
+  of values without any string copies or parsing.
+  No backwards compatibility is planned, as it would require code duplication
+  in every PMD that supports xstats.
+
 * ABI changes are planned for adding four new flow types. This impacts
   RTE_ETH_FLOW_MAX. The release 2.2 does not contain these ABI changes,
   but release 2.3 will. [postponed]