[dpdk-dev,v2,5/5] doc: distributor library changes for new burst api
Checks
Commit Message
Signed-off-by: David Hunt <david.hunt@intel.com>
---
doc/guides/prog_guide/packet_distrib_lib.rst | 4 ++++
1 file changed, 4 insertions(+)
@@ -42,6 +42,10 @@ The model of operation is shown in the diagram below.
Packet Distributor mode of operation
+There are two versions of the API in the distributor Library, one which sends one packet at a time to workers,
+and another which sends bursts of up to 8 packets at a time to workers. The functions names of the second API
+are identified by "_burst", and must not be intermixed with the single packet API. The operations described below
+apply to both API's, select which API you wish to use by including the relevant header file.
Distributor Core Operation
--------------------------