[dpdk-dev] [PATCH 31/33] doc/testeventdev: add "perf queue" test details

[Jerin Jacob]

-----Original Message-----
> Date: Thu, 1 Jun 2017 21:11:29 +0000
> From: "Eads, Gage" <gage.eads at intel.com>
> To: Jerin Jacob <jerin.jacob at caviumnetworks.com>, "dev at dpdk.org"
>  <dev at dpdk.org>
> CC: "Richardson, Bruce" <bruce.richardson at intel.com>, "Van Haaren, Harry"
>  <harry.van.haaren at intel.com>, "hemant.agrawal at nxp.com"
>  <hemant.agrawal at nxp.com>, "nipun.gupta at nxp.com" <nipun.gupta at nxp.com>,
>  "Vangati, Narender" <narender.vangati at intel.com>, "Rao, Nikhil"
>  <nikhil.rao at intel.com>, "gprathyusha at caviumnetworks.com"
>  <gprathyusha at caviumnetworks.com>, "Mcnamara, John"
>  <john.mcnamara at intel.com>
> Subject: RE: [dpdk-dev] [PATCH 31/33] doc/testeventdev: add "perf queue"
>  test details
> 
> <snip>
> 
> >  diff --git a/doc/guides/tools/testeventdev.rst
> >  b/doc/guides/tools/testeventdev.rst
> >  index 02b7a8a57..b895b2d2b 100644
> >  --- a/doc/guides/tools/testeventdev.rst
> >  +++ b/doc/guides/tools/testeventdev.rst
> >  @@ -297,4 +297,90 @@ Example command to run order ``all types queue``
> >  test:
> >      sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- --
> >  test=order_atq --plcore 1 --wlcores 2,3
> >  
> >  
> >  +PERF_QUEUE Test
> >  +~~~~~~~~~~~~~~~
> >  +
> >  +This is a performance test case that aims at testing the following:
> >  +
> >  +#. Measure the number of events can be processed in a second.
> >  +#. Measure the latency to forward an event.
> >  +
> >  +.. _table_eventdev_perf_queue_test:
> >  +
> >  +.. table:: Perf queue test eventdev configuration.
> >  +
> >  +   +---+--------------+----------------+-----------------------------------------+
> >  +   | # | Items        | Value          | Comments                                |
> >  +   |   |              |                |                                         |
> >  +
> >  +===+==============+================+===========================
> >  ==============+
> >  +   | 1 | nb_queues    | nb_producers * | Queues will be configured based on
> >  the  |
> >  +   |   |              | nb_stages      | user requested sched type list(--stlist)|
> >  +   +---+--------------+----------------+-----------------------------------------+
> >  +   | 2 | nb_producers | >= 1           | Selected through --plcores command line |
> >  +   |   |              |                | argument.                               |
> >  +   +---+--------------+----------------+-----------------------------------------+
> >  +   | 3 | nb_workers   | >= 1           | Selected through --wlcores command line |
> >  +   |   |              |                | argument                                |
> >  +   +---+--------------+----------------+-----------------------------------------+
> >  +   | 4 | nb_ports     | nb_workers +   | Workers use port 0 to port w.           |
> >  +   |   |              | nb_producers   | Producers use port w to port p          |
> >  +   +---+--------------+----------------+-----------------------------------------+
> 
> Just a suggestion: consider changing 'w' (i.e. "Workers use port 0 to port w") to'n', or vice versa, so the text matches the diagram. Applies to perf_atq as well.

Sure.