diff mbox series

[4/9] perf docs: use canonical ftrace path

Message ID 20230130181915.1113313-5-zwisler@google.com (mailing list archive)
State Accepted
Commit 1df49ef9ee3179a213754a26cc64065e8aa24c0c
Headers show
Series use canonical ftrace path whenever possible | expand

Commit Message

Ross Zwisler Jan. 30, 2023, 6:19 p.m. UTC
The canonical location for the tracefs filesystem is at /sys/kernel/tracing.

But, from Documentation/trace/ftrace.rst:

  Before 4.1, all ftrace tracing control files were within the debugfs
  file system, which is typically located at /sys/kernel/debug/tracing.
  For backward compatibility, when mounting the debugfs file system,
  the tracefs file system will be automatically mounted at:

  /sys/kernel/debug/tracing

A few spots in the perf docs still refer to this older debugfs path, so
let's update them to avoid confusion.

Signed-off-by: Ross Zwisler <zwisler@google.com>
---
 tools/perf/Documentation/perf-list.txt          | 2 +-
 tools/perf/Documentation/perf-script-perl.txt   | 2 +-
 tools/perf/Documentation/perf-script-python.txt | 4 ++--
 3 files changed, 4 insertions(+), 4 deletions(-)

Comments

Arnaldo Carvalho de Melo Feb. 2, 2023, 1:24 a.m. UTC | #1
Em Mon, Jan 30, 2023 at 11:19:10AM -0700, Ross Zwisler escreveu:
> The canonical location for the tracefs filesystem is at /sys/kernel/tracing.
> 
> But, from Documentation/trace/ftrace.rst:
> 
>   Before 4.1, all ftrace tracing control files were within the debugfs
>   file system, which is typically located at /sys/kernel/debug/tracing.
>   For backward compatibility, when mounting the debugfs file system,
>   the tracefs file system will be automatically mounted at:
> 
>   /sys/kernel/debug/tracing
> 
> A few spots in the perf docs still refer to this older debugfs path, so
> let's update them to avoid confusion.

Thanks, applied.

- Arnaldo

 
> Signed-off-by: Ross Zwisler <zwisler@google.com>
> ---
>  tools/perf/Documentation/perf-list.txt          | 2 +-
>  tools/perf/Documentation/perf-script-perl.txt   | 2 +-
>  tools/perf/Documentation/perf-script-python.txt | 4 ++--
>  3 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt
> index 57384a97c04f..6c83459d3192 100644
> --- a/tools/perf/Documentation/perf-list.txt
> +++ b/tools/perf/Documentation/perf-list.txt
> @@ -228,7 +228,7 @@ This can be overridden by setting the kernel.perf_event_paranoid
>  sysctl to -1, which allows non root to use these events.
>  
>  For accessing trace point events perf needs to have read access to
> -/sys/kernel/debug/tracing, even when perf_event_paranoid is in a relaxed
> +/sys/kernel/tracing, even when perf_event_paranoid is in a relaxed
>  setting.
>  
>  TRACING
> diff --git a/tools/perf/Documentation/perf-script-perl.txt b/tools/perf/Documentation/perf-script-perl.txt
> index fa4f39d305a7..5b479f5e62ff 100644
> --- a/tools/perf/Documentation/perf-script-perl.txt
> +++ b/tools/perf/Documentation/perf-script-perl.txt
> @@ -55,7 +55,7 @@ Traces meant to be processed using a script should be recorded with
>  the above option: -a to enable system-wide collection.
>  
>  The format file for the sched_wakeup event defines the following fields
> -(see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
> +(see /sys/kernel/tracing/events/sched/sched_wakeup/format):
>  
>  ----
>   format:
> diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt
> index cf4b7f4b625a..6a8581012e16 100644
> --- a/tools/perf/Documentation/perf-script-python.txt
> +++ b/tools/perf/Documentation/perf-script-python.txt
> @@ -319,7 +319,7 @@ So those are the essential steps in writing and running a script.  The
>  process can be generalized to any tracepoint or set of tracepoints
>  you're interested in - basically find the tracepoint(s) you're
>  interested in by looking at the list of available events shown by
> -'perf list' and/or look in /sys/kernel/debug/tracing/events/ for
> +'perf list' and/or look in /sys/kernel/tracing/events/ for
>  detailed event and field info, record the corresponding trace data
>  using 'perf record', passing it the list of interesting events,
>  generate a skeleton script using 'perf script -g python' and modify the
> @@ -449,7 +449,7 @@ Traces meant to be processed using a script should be recorded with
>  the above option: -a to enable system-wide collection.
>  
>  The format file for the sched_wakeup event defines the following fields
> -(see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
> +(see /sys/kernel/tracing/events/sched/sched_wakeup/format):
>  
>  ----
>   format:
> -- 
> 2.39.1.456.gfc5497dd1b-goog
>
diff mbox series

Patch

diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt
index 57384a97c04f..6c83459d3192 100644
--- a/tools/perf/Documentation/perf-list.txt
+++ b/tools/perf/Documentation/perf-list.txt
@@ -228,7 +228,7 @@  This can be overridden by setting the kernel.perf_event_paranoid
 sysctl to -1, which allows non root to use these events.
 
 For accessing trace point events perf needs to have read access to
-/sys/kernel/debug/tracing, even when perf_event_paranoid is in a relaxed
+/sys/kernel/tracing, even when perf_event_paranoid is in a relaxed
 setting.
 
 TRACING
diff --git a/tools/perf/Documentation/perf-script-perl.txt b/tools/perf/Documentation/perf-script-perl.txt
index fa4f39d305a7..5b479f5e62ff 100644
--- a/tools/perf/Documentation/perf-script-perl.txt
+++ b/tools/perf/Documentation/perf-script-perl.txt
@@ -55,7 +55,7 @@  Traces meant to be processed using a script should be recorded with
 the above option: -a to enable system-wide collection.
 
 The format file for the sched_wakeup event defines the following fields
-(see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
+(see /sys/kernel/tracing/events/sched/sched_wakeup/format):
 
 ----
  format:
diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt
index cf4b7f4b625a..6a8581012e16 100644
--- a/tools/perf/Documentation/perf-script-python.txt
+++ b/tools/perf/Documentation/perf-script-python.txt
@@ -319,7 +319,7 @@  So those are the essential steps in writing and running a script.  The
 process can be generalized to any tracepoint or set of tracepoints
 you're interested in - basically find the tracepoint(s) you're
 interested in by looking at the list of available events shown by
-'perf list' and/or look in /sys/kernel/debug/tracing/events/ for
+'perf list' and/or look in /sys/kernel/tracing/events/ for
 detailed event and field info, record the corresponding trace data
 using 'perf record', passing it the list of interesting events,
 generate a skeleton script using 'perf script -g python' and modify the
@@ -449,7 +449,7 @@  Traces meant to be processed using a script should be recorded with
 the above option: -a to enable system-wide collection.
 
 The format file for the sched_wakeup event defines the following fields
-(see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
+(see /sys/kernel/tracing/events/sched/sched_wakeup/format):
 
 ----
  format: