diff mbox

[dpdk-dev,v10,16/18] doc: distributor library changes for new burst API

Message ID 1489558767-56329-17-git-send-email-david.hunt@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Hunt, David March 15, 2017, 6:19 a.m. UTC 
  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>
---
 doc/guides/prog_guide/packet_distrib_lib.rst | 3 +++
 1 file changed, 3 insertions(+)
diff mbox

Patch

diff --git a/doc/guides/prog_guide/packet_distrib_lib.rst b/doc/guides/prog_guide/packet_distrib_lib.rst
index b5bdabb..e0adcaa 100644
--- a/doc/guides/prog_guide/packet_distrib_lib.rst
+++ b/doc/guides/prog_guide/packet_distrib_lib.rst
@@ -42,6 +42,9 @@  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 optiomised 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
 --------------------------