Re: [dpdk-dev] [PATCH v5 2/3] doc: add sw eventdev pipeline to sample app ug

[Jerin Jacob <jerin.jacob@caviumnetworks.com>]

-----Original Message-----
> Date: Mon, 3 Jul 2017 10:25:17 +0100
> From: "Hunt, David" <david.hunt@intel.com>
> To: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> CC: dev@dpdk.org, harry.van.haaren@intel.com
> Subject: Re: [PATCH v5 2/3] doc: add sw eventdev pipeline to sample app ug
> User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; rv:45.0) Gecko/20100101
>  Thunderbird/45.8.0
> 
> Hi Jerin,
> 
> 
> On 3/7/2017 6:37 AM, Jerin Jacob wrote:
> > -----Original Message-----
> > > From: Harry van Haaren <harry.van.haaren@intel.com>
> > > > Adi a new entry in the sample app user-guides,
> > > which details the working of the eventdev_pipeline_sw.
> > > 
> > > Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
> > > Signed-off-by: David Hunt <david.hunt@intel.com>
> > > ---
> > >   doc/guides/sample_app_ug/eventdev_pipeline_sw.rst | 190 ++++++++++++++++++++++
> > >   doc/guides/sample_app_ug/index.rst                |   1 +
> > >   2 files changed, 191 insertions(+)
> > >   create mode 100644 doc/guides/sample_app_ug/eventdev_pipeline_sw.rst
> > > 
> > > diff --git a/doc/guides/sample_app_ug/eventdev_pipeline_sw.rst b/doc/guides/sample_app_ug/eventdev_pipeline_sw.rst
> > > new file mode 100644
> > > index 0000000..65c33a8
> > > --- /dev/null
> > > +++ b/doc/guides/sample_app_ug/eventdev_pipeline_sw.rst
> > > @@ -0,0 +1,190 @@
> > > +
> > > +
> > > +Eventdev Pipeline SW Sample Application
> > Eventdev Pipeline SW PMD Sample Application
> 
> Sure.
> 
> > > +=======================================
> > > +
> > > +The eventdev pipeline sample application is a sample app that demonstrates
> > > +the usage of the eventdev API using the software PMD. It shows how an
> > > +application can configure a pipeline and assign a set of worker cores to
> > > +perform the processing required.
> > > +
> > > +The application has a range of command line arguments allowing it to be
> > > +configured for various numbers worker cores, stages,queue depths and cycles per
> > > +stage of work. This is useful for performance testing as well as quickly testing
> > > +a particular pipeline configuration.
> > > +
> > > +
> > > +statistics that the PMD provides. The statistics provided depend on the PMD
> > > +used, see the Event Device Drivers section for a list of eventdev PMDs.
> > > diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst
> > > index 02611ef..90be36a 100644
> > > --- a/doc/guides/sample_app_ug/index.rst
> > > +++ b/doc/guides/sample_app_ug/index.rst
> > > @@ -69,6 +69,7 @@ Sample Applications User Guides
> > >       netmap_compatibility
> > >       ip_pipeline
> > >       test_pipeline
> > > +    eventdev_pipeline_sw
> > eventdev_pipeline_sw_pmd
> 
> There's no need to change this, it would  break 'make doc'
> The filename of the .rst is
> "./doc/guides/sample_app_ug/eventdev_pipeline_sw.rst"
> The app called eventdev_pipeline_sw.

OK

> 
> > >       dist_app
> > >       vm_power_management
> > >       tep_termination
> > With above changes:
> > 
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > 
>