diff mbox series

doc: enhance arm64 profiling documentation

Message ID 20210711075821.3022587-1-jerinj@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: enhance arm64 profiling documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Jerin Jacob Kollanukkaran July 11, 2021, 7:58 a.m. UTC 
  From: Jerin Jacob <jerinj@marvell.com>

Documented the role of RTE_ARM_EAL_RDTSC_USE_PMU to enable
PMU based rte_rdtsc().

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 doc/guides/prog_guide/profile_app.rst | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Comments

Ruifeng Wang July 12, 2021, 6:39 a.m. UTC | #1 
> -----Original Message-----
> From: jerinj@marvell.com <jerinj@marvell.com>
> Sent: Sunday, July 11, 2021 3:58 PM
> Cc: dev@dpdk.org; thomas@monjalon.net; Ruifeng Wang
> <Ruifeng.Wang@arm.com>; jerinj@marvell.com
> Subject: [PATCH] doc: enhance arm64 profiling documentation
> 
> From: Jerin Jacob <jerinj@marvell.com>
> 
> Documented the role of RTE_ARM_EAL_RDTSC_USE_PMU to enable PMU
> based rte_rdtsc().
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---
>  doc/guides/prog_guide/profile_app.rst | 11 ++++++++++-
>  1 file changed, 10 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/prog_guide/profile_app.rst
> b/doc/guides/prog_guide/profile_app.rst
> index 52f85bb9e0..bd6700ef85 100644
> --- a/doc/guides/prog_guide/profile_app.rst
> +++ b/doc/guides/prog_guide/profile_app.rst
> @@ -94,7 +94,16 @@ an ARMv8 machine.
>      make
>      sudo insmod pmu_el0_cycle_counter.ko
> 
> -Please refer to :doc:`../linux_gsg/build_dpdk` for details on compiling DPDK
> with meson.
> +Please refer to :doc:`../linux_gsg/build_dpdk` for generic details on
> compiling DPDK with meson.
> +
> +In order to enable ``PMU`` based ``rte_rdtsc()``, user needs to
> +configure the build with ``-Dc_args='-DRTE_ARM_EAL_RDTSC_USE_PMU'``.
> +
> +Example:
> +
> +.. code-block:: console
> +
> +   meson --cross config/arm/arm64_armv8_linux_gcc
> + -Dc_args='-DRTE_ARM_EAL_RDTSC_USE_PMU' build
> 
>  .. warning::
> 
> --
> 2.32.0
Acked-by: Ruifeng Wang <ruifeng.wang@arm.com>
Thomas Monjalon July 31, 2021, 4:42 p.m. UTC | #2 
> > From: Jerin Jacob <jerinj@marvell.com>
> > 
> > Documented the role of RTE_ARM_EAL_RDTSC_USE_PMU to enable PMU
> > based rte_rdtsc().
> > 
> > Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> Acked-by: Ruifeng Wang <ruifeng.wang@arm.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst
index 52f85bb9e0..bd6700ef85 100644
--- a/doc/guides/prog_guide/profile_app.rst
+++ b/doc/guides/prog_guide/profile_app.rst
@@ -94,7 +94,16 @@  an ARMv8 machine.
     make
     sudo insmod pmu_el0_cycle_counter.ko
 
-Please refer to :doc:`../linux_gsg/build_dpdk` for details on compiling DPDK with meson.
+Please refer to :doc:`../linux_gsg/build_dpdk` for generic details on compiling DPDK with meson.
+
+In order to enable ``PMU`` based ``rte_rdtsc()``, user needs to configure the
+build with ``-Dc_args='-DRTE_ARM_EAL_RDTSC_USE_PMU'``.
+
+Example:
+
+.. code-block:: console
+
+   meson --cross config/arm/arm64_armv8_linux_gcc -Dc_args='-DRTE_ARM_EAL_RDTSC_USE_PMU' build
 
 .. warning::