From: David Hunt <david.hunt@intel.com>
Date: Mon, 20 Mar 2017 10:08:40 +0000 (+0000)
Subject: doc: update distributor lib guide for new burst API
X-Git-Tag: spdx-start~4377
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=7e0bb29923bb315ac05f5c765b8f3e94e2d5d6a1;p=dpdk.git

doc: update distributor lib guide for new burst API

Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---

diff --git a/doc/guides/prog_guide/packet_distrib_lib.rst b/doc/guides/prog_guide/packet_distrib_lib.rst
index b5bdabbf69..ee2b1a668f 100644
--- a/doc/guides/prog_guide/packet_distrib_lib.rst
+++ b/doc/guides/prog_guide/packet_distrib_lib.rst
@@ -42,6 +42,10 @@ The model of operation is shown in the diagram below.
 
    Packet Distributor mode of operation
 
+There are two modes of operation of the API in the distributor library,
+one which sends one packet at a time to workers using 32-bits for flow_id,
+and an optimized mode which sends bursts of up to 8 packets at a time to workers, using 15 bits of flow_id.
+The mode is selected by the type field in the ``rte_distributor_create()`` function.
 
 Distributor Core Operation
 --------------------------