From mboxrd@z Thu Jan 1 00:00:00 1970 From: David Hunt Subject: [PATCH v5 6/6] doc: distributor library changes for new burst API Date: Fri, 20 Jan 2017 09:18:53 +0000 Message-ID: <1484903933-127190-7-git-send-email-david.hunt@intel.com> References: <1483948248-91364-2-git-send-email-david.hunt@intel.com> <1484903933-127190-1-git-send-email-david.hunt@intel.com> Cc: bruce.richardson@intel.com, David Hunt To: dev@dpdk.org Return-path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 903412B9B for ; Fri, 20 Jan 2017 17:18:00 +0100 (CET) In-Reply-To: <1484903933-127190-1-git-send-email-david.hunt@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: David Hunt --- doc/guides/prog_guide/packet_distrib_lib.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/guides/prog_guide/packet_distrib_lib.rst b/doc/guides/prog_guide/packet_distrib_lib.rst index b5bdabb..dffd4ad 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 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 -------------------------- -- 2.7.4