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

Message ID 1490004522-183515-17-git-send-email-david.hunt@intel.com
State Accepted, archived
Headers show

Checks

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

Commit Message

David Hunt March 20, 2017, 10:08 a.m.
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(+)

Comments

John McNamara March 24, 2017, 2:49 p.m.
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Hunt
> Sent: Monday, March 20, 2017 10:09 AM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>; Hunt, David
> <david.hunt@intel.com>
> Subject: [dpdk-dev] [PATCH v11 16/18] doc: distributor library changes 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>
> ---
>  doc/guides/prog_guide/packet_distrib_lib.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
> 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``.


s/Library/library
s/optiomised/optimized/
s/rte_distributor_create function``/rte_distributor_create()`` function/

Patch hide | download patch | download mbox

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
 --------------------------