Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 34d4453d authored by SeongJae Park's avatar SeongJae Park Committed by Arnaldo Carvalho de Melo
Browse files

perf script: Fix documentation errors 



This commit fixes two errors in documents for perf-script-python and
perf-script-perl as below:

- /sys/kernel/debug/tracing events -> /sys/kernel/debug/tracing/events/
- trace_handled -> trace_unhandled

Signed-off-by: default avatarSeongJae Park <sj38.park@gmail.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Tom Zanussi <tzanussi@gmail.com>
Fixes: cff68e58 ("perf/scripts: Add perf-trace-python Documentation")
Link: http://lkml.kernel.org/r/20170530111827.21732-3-sj38.park@gmail.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent c76132dc

tools/perf/Documentation/perf-script-perl.txt

+1 −1
Original line number Original line Diff line number Diff line
@@ -39,7 +39,7 @@ EVENT HANDLERS 
When perf script is invoked using a trace script, a user-defined

When perf script is invoked using a trace script, a user-defined

'handler function' is called for each event in the trace.  If there's

'handler function' is called for each event in the trace.  If there's

no handler function defined for a given event type, the event is

no handler function defined for a given event type, the event is

ignored (or passed to a 'trace_handled' function, see below) and the

ignored (or passed to a 'trace_unhandled' function, see below) and the

next event is processed.

next event is processed.





Most of the event's field values are passed as arguments to the

Most of the event's field values are passed as arguments to the

tools/perf/Documentation/perf-script-python.txt

+2 −2
Original line number Original line Diff line number Diff line
@@ -321,7 +321,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

process can be generalized to any tracepoint or set of tracepoints

you're interested in - basically find the tracepoint(s) you're

you're interested in - basically find the tracepoint(s) you're

interested in by looking at the list of available events shown by

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/debug/tracing/events/ for

detailed event and field info, record the corresponding trace data

detailed event and field info, record the corresponding trace data

using 'perf record', passing it the list of interesting events,

using 'perf record', passing it the list of interesting events,

generate a skeleton script using 'perf script -g python' and modify the

generate a skeleton script using 'perf script -g python' and modify the
@@ -437,7 +437,7 @@ EVENT HANDLERS 
When perf script is invoked using a trace script, a user-defined

When perf script is invoked using a trace script, a user-defined

'handler function' is called for each event in the trace.  If there's

'handler function' is called for each event in the trace.  If there's

no handler function defined for a given event type, the event is

no handler function defined for a given event type, the event is

ignored (or passed to a 'trace_handled' function, see below) and the

ignored (or passed to a 'trace_unhandled' function, see below) and the

next event is processed.

next event is processed.





Most of the event's field values are passed as arguments to the

Most of the event's field values are passed as arguments to the