From patchwork Fri Jan 20 09:18:53 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Hunt, David" X-Patchwork-Id: 19853 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id D6C62F94E; Fri, 20 Jan 2017 17:18:24 +0100 (CET) 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) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga104.jf.intel.com with ESMTP; 20 Jan 2017 08:18:00 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,259,1477983600"; d="scan'208";a="811316122" Received: from silpixa00397515.ir.intel.com (HELO silpixa00397515.ger.corp.intel.com) ([10.237.223.14]) by FMSMGA003.fm.intel.com with ESMTP; 20 Jan 2017 08:17:58 -0800 From: David Hunt To: dev@dpdk.org Cc: bruce.richardson@intel.com, David Hunt Date: Fri, 20 Jan 2017 09:18:53 +0000 Message-Id: <1484903933-127190-7-git-send-email-david.hunt@intel.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1484903933-127190-1-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> Subject: [dpdk-dev] [PATCH v5 6/6] doc: distributor library changes for new burst API X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list 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 --------------------------