From 7a53028af5249c7d95b33bc9b5812dcc36cac0c4 Mon Sep 17 00:00:00 2001
From: David Hunt <david.hunt@intel.com>
Date: Mon, 6 Feb 2017 08:08:29 +0000
Subject: [PATCH] doc: add distributor library API change notice

Given that the packet distributor library improvements (1) will
not be in 17.02, I plan on doing some consolidation of the
API for burst operation for 17.05, merging the two api's into
one, with options for single or burst operation.

(1) http://dpdk.org/dev/patchwork/patch/19911/

Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index f0b53292c3..97d87fd525 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -50,3 +50,9 @@ Deprecation Notices
   PMDs that implement the latter.
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
+
+* distributor: library API will be changed to incorporate a burst-oriented
+  API. This will include a change to ``rte_distributor_create``
+  to specify which type of instance to create (single or burst), and
+  additional calls for ``rte_distributor_poll_pkt_burst`` and
+  ``rte_distributor_return_pkt_burst``, among others.
-- 
2.39.5