[PATCH] Documentation: coresight: Fix documentation issue

[PATCH] Documentation: coresight: Fix documentation issue

[Mike Leach]

Fix the description of the directories and attributes used
in cs_etm as used by perf.

Drop the references to the 'configurations' sub-directory which
had been removed in an earlier version of the patchset.

Fixes: f71cd93d5ea4 ("Documentation: coresight: Add documentation for CoreSight config")
Reported-by: German Gomex <german.gomez@arm.com>
Signed-off-by: Mike Leach <mike.leach@linaro.org>
---
 .../trace/coresight/coresight-config.rst         | 16 +++++-----------
 1 file changed, 5 insertions(+), 11 deletions(-)

diff --git a/Documentation/trace/coresight/coresight-config.rst b/Documentation/trace/coresight/coresight-config.rst
index a4e3ef295240..6ed13398ca2c 100644
--- a/Documentation/trace/coresight/coresight-config.rst
+++ b/Documentation/trace/coresight/coresight-config.rst
@@ -211,19 +211,13 @@ also declared in the perf 'cs_etm' event infrastructure so that they can
 be selected when running trace under perf::
 
     $ ls /sys/devices/cs_etm
-    configurations  format  perf_event_mux_interval_ms  sinks  type
-    events  nr_addr_filters  power
+    cpu0  cpu2  events  nr_addr_filters		power  subsystem  uevent
+    cpu1  cpu3  format  perf_event_mux_interval_ms	sinks  type
 
-Key directories here are 'configurations' - which lists the loaded
-configurations, and 'events' - a generic perf directory which allows
-selection on the perf command line.::
+The key directory here is 'events' - a generic perf directory which allows
+selection on the perf command line. As with the sinks entries, this provides
+a hash of the configuration name.
 
-    $ ls configurations/
-    autofdo
-    $ cat configurations/autofdo
-    0xa7c3dddd
-
-As with the sinks entries, this provides a hash of the configuration name.
 The entry in the 'events' directory uses perfs built in syntax generator
 to substitute the syntax for the name when evaluating the command::
 
-- 
2.17.1

Re: [PATCH] Documentation: coresight: Fix documentation issue

[Mathieu Poirier]

On Wed, Nov 17, 2021 at 04:42:20PM +0000, Mike Leach wrote:
> Fix the description of the directories and attributes used
> in cs_etm as used by perf.
> 
> Drop the references to the 'configurations' sub-directory which
> had been removed in an earlier version of the patchset.
> 
> Fixes: f71cd93d5ea4 ("Documentation: coresight: Add documentation for CoreSight config")
> Reported-by: German Gomex <german.gomez@arm.com>
> Signed-off-by: Mike Leach <mike.leach@linaro.org>
> ---
>  .../trace/coresight/coresight-config.rst         | 16 +++++-----------
>  1 file changed, 5 insertions(+), 11 deletions(-)

I have applied this patch.

Thanks,
Mathieu

> 
> diff --git a/Documentation/trace/coresight/coresight-config.rst b/Documentation/trace/coresight/coresight-config.rst
> index a4e3ef295240..6ed13398ca2c 100644
> --- a/Documentation/trace/coresight/coresight-config.rst
> +++ b/Documentation/trace/coresight/coresight-config.rst
> @@ -211,19 +211,13 @@ also declared in the perf 'cs_etm' event infrastructure so that they can
>  be selected when running trace under perf::
>  
>      $ ls /sys/devices/cs_etm
> -    configurations  format  perf_event_mux_interval_ms  sinks  type
> -    events  nr_addr_filters  power
> +    cpu0  cpu2  events  nr_addr_filters		power  subsystem  uevent
> +    cpu1  cpu3  format  perf_event_mux_interval_ms	sinks  type
>  
> -Key directories here are 'configurations' - which lists the loaded
> -configurations, and 'events' - a generic perf directory which allows
> -selection on the perf command line.::
> +The key directory here is 'events' - a generic perf directory which allows
> +selection on the perf command line. As with the sinks entries, this provides
> +a hash of the configuration name.
>  
> -    $ ls configurations/
> -    autofdo
> -    $ cat configurations/autofdo
> -    0xa7c3dddd
> -
> -As with the sinks entries, this provides a hash of the configuration name.
>  The entry in the 'events' directory uses perfs built in syntax generator
>  to substitute the syntax for the name when evaluating the command::
>  
> -- 
> 2.17.1
> 

Re: [PATCH] Documentation: coresight: Fix documentation issue

[Mathieu Poirier]

Good day Mike,

On Wed, Nov 17, 2021 at 04:42:20PM +0000, Mike Leach wrote:
> Fix the description of the directories and attributes used
> in cs_etm as used by perf.
> 
> Drop the references to the 'configurations' sub-directory which
> had been removed in an earlier version of the patchset.
> 
> Fixes: f71cd93d5ea4 ("Documentation: coresight: Add documentation for CoreSight config")
> Reported-by: German Gomex <german.gomez@arm.com>
> Signed-off-by: Mike Leach <mike.leach@linaro.org>
> ---
>  .../trace/coresight/coresight-config.rst         | 16 +++++-----------
>  1 file changed, 5 insertions(+), 11 deletions(-)

I have applied your patch.

Thanks,
Mathieu

> 
> diff --git a/Documentation/trace/coresight/coresight-config.rst b/Documentation/trace/coresight/coresight-config.rst
> index a4e3ef295240..6ed13398ca2c 100644
> --- a/Documentation/trace/coresight/coresight-config.rst
> +++ b/Documentation/trace/coresight/coresight-config.rst
> @@ -211,19 +211,13 @@ also declared in the perf 'cs_etm' event infrastructure so that they can
>  be selected when running trace under perf::
>  
>      $ ls /sys/devices/cs_etm
> -    configurations  format  perf_event_mux_interval_ms  sinks  type
> -    events  nr_addr_filters  power
> +    cpu0  cpu2  events  nr_addr_filters		power  subsystem  uevent
> +    cpu1  cpu3  format  perf_event_mux_interval_ms	sinks  type
>  
> -Key directories here are 'configurations' - which lists the loaded
> -configurations, and 'events' - a generic perf directory which allows
> -selection on the perf command line.::
> +The key directory here is 'events' - a generic perf directory which allows
> +selection on the perf command line. As with the sinks entries, this provides
> +a hash of the configuration name.
>  
> -    $ ls configurations/
> -    autofdo
> -    $ cat configurations/autofdo
> -    0xa7c3dddd
> -
> -As with the sinks entries, this provides a hash of the configuration name.
>  The entry in the 'events' directory uses perfs built in syntax generator
>  to substitute the syntax for the name when evaluating the command::
>  
> -- 
> 2.17.1
>