doc: add profile with vtune section to prog guide

84720 diff mbox series

From: Eugeny Parshutin <eugeny.parshutin@linux.intel.com>

Return back 'profiling with vtune' section to profiling programmers
guide with updated instruction on how to enable vtune profiling
with meson configuration option.

Signed-off-by: Eugeny Parshutin <eugeny.parshutin@linux.intel.com>
---
 doc/guides/prog_guide/profile_app.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

On Wed, Dec 02, 2020 at 08:48:06PM +0300, eugeny.parshutin@linux.intel.com wrote:
> From: Eugeny Parshutin <eugeny.parshutin@linux.intel.com>
> 
> Return back 'profiling with vtune' section to profiling programmers
> guide with updated instruction on how to enable vtune profiling
> with meson configuration option.
> 
> Signed-off-by: Eugeny Parshutin <eugeny.parshutin@linux.intel.com>
> ---
>  doc/guides/prog_guide/profile_app.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst
> index 709368198..c87ca5d9d 100644
> --- a/doc/guides/prog_guide/profile_app.rst
> +++ b/doc/guides/prog_guide/profile_app.rst
> @@ -33,6 +33,20 @@ Refer to the
>  for details about application profiling.
>  
>  
> +Profiling with VTune
> +~~~~~~~~~~~~~~~~~~~~
> +
> +To allow VTune attaching to the DPDK application, reconfigure a DPDK build
> +folder by passing ``-Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1`` meson option
> +and recompile the DPDK:
> +
> +.. code-block:: console
> +
> +    meson build
> +    meson configure build -Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1
> +    ninja -C build
> +
Since the VTUNE parts seem to be protected by just "#ifdef" rather than a
check for a specific value, I think the "=1" can be omitted in the
instructions. That should also make the quoted unnecessary.

With that change to simplify things,

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

13/01/2021 18:11, Bruce Richardson:
> On Wed, Dec 02, 2020 at 08:48:06PM +0300, eugeny.parshutin@linux.intel.com wrote:
> > From: Eugeny Parshutin <eugeny.parshutin@linux.intel.com>
> > 
> > Return back 'profiling with vtune' section to profiling programmers
> > guide with updated instruction on how to enable vtune profiling
> > with meson configuration option.
> > 
> > Signed-off-by: Eugeny Parshutin <eugeny.parshutin@linux.intel.com>
> > ---
> > +Profiling with VTune
> > +~~~~~~~~~~~~~~~~~~~~
> > +
> > +To allow VTune attaching to the DPDK application, reconfigure a DPDK build
> > +folder by passing ``-Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1`` meson option
> > +and recompile the DPDK:
> > +
> > +.. code-block:: console
> > +
> > +    meson build
> > +    meson configure build -Dc_args='-DRTE_ETHDEV_PROFILE_WITH_VTUNE'=1
> > +    ninja -C build
> > +
> Since the VTUNE parts seem to be protected by just "#ifdef" rather than a
> check for a specific value, I think the "=1" can be omitted in the
> instructions. That should also make the quoted unnecessary.
> 
> With that change to simplify things,
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Fixes: 89c67ae2cba7 ("doc: remove references to make from prog guide")
Cc: stable@dpdk.org

Applied with above changes, thanks.