perf: Fix few nitpicks in perf-script

Script that generated by '--gen-script' option contains an outdated comment. It mentions about 'perf-trace-python' document while it has renamed to 'perf-script-python'. This commit fixes the outdated comment.

Signed-off-by SeongJae Park <[email protected]>

Fixes 133dc4c39c57 ("perf: Rename 'perf trace' to 'perf script'")

---
 tools/perf/util/scripting-engines/trace-event-python.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

tools/perf/util/scripting-engines/trace-event-python.c +1 -1

index 9d92af7d0718..40de3cb40d21 100644
@@ -1219,7 +1219,7 @@ static int python_generate_script(struct pevent *pevent, const char *outfile)
 	fprintf(ofp, "# be retrieved using Python functions of the form "
 		"common_*(context).\n");
 
-	fprintf(ofp, "# See the perf-trace-python Documentation for the list "
+	fprintf(ofp, "# See the perf-script-python Documentation for the list "
 		"of available functions.\n\n");
 
 	fprintf(ofp, "import os\n");

Signature · 1 line

2.13.0

This commit fixes two typos 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 SeongJae Park <[email protected]>

Fixes cff68e582237 ("perf/scripts: Add perf-trace-python Documentation")

---
 tools/perf/Documentation/perf-script-perl.txt   | 2 +-
 tools/perf/Documentation/perf-script-python.txt | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

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

index dfbb506d2c34..142606c0ec9c 100644
@@ -39,7 +39,7 @@ EVENT HANDLERS
 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
 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.
 
 Most of the event's field values are passed as arguments to the

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

index 54acba221558..087b87c956ba 100644
@@ -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
 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/debug/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

@@ -437,7 +437,7 @@ EVENT HANDLERS
 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
 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.
 
 Most of the event's field values are passed as arguments to the

Signature · 1 line

2.13.0

This commit fixes wrong code snippets for trace_begin() and trace_end() function example definition.

Signed-off-by SeongJae Park <[email protected]>

---
 tools/perf/Documentation/perf-script-python.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

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

index 44e51351536f..f723ce41268c 100644
@@ -530,7 +530,7 @@ can implement a set of optional functions:
 gives scripts a chance to do setup tasks:
 
 ----
-def trace_begin:
+def trace_begin():
     pass
 ----
 

@@ -539,7 +539,7 @@ def trace_begin:
  as display results:
 
 ----
-def trace_end:
+def trace_end():
     pass
 ----
 

Signature · 1 line

2.13.0

Em Tue, May 30, 2017 at 08:18:26PM +0900, SeongJae Park escreveu:

Quoted 2 lines

This commit fixes wrong code snippets for trace_begin() and trace_end() function example definition.

Fixed, and using:

  git log --follow tools/perf/Documentation/perf-script-python.txt

Added the Fixes: tag:

Fixes cff68e582237 ("perf/scripts: Add perf-trace-python Documentation")

And since you're taking the time to add the Fixes tag (yay, great!) please also add Cc: entries for the patch author and committer, in that case:

Cc Tom Zanussi <[email protected]>

Cc Frederic Weisbecker <[email protected]>

I did it this time, using a script I have:

[acme@jouet linux]$ cat ~/bin/fixes
#!/bin/bash

cset=$1
if [ $# -eq 0 ] ; then
read cset
fi
git show --pretty=fuller $cset | grep '^\(Author\|Commit\): ' | sed -r 's/.*: +/Cc: /g' echo Fixes: git one $cset
[acme@jouet linux]$

Just get the cset, in vim, and select it, pressing Shift+V while the cursor is on top of the cset id and then press : and finally !fixes + ENTER :)

cff68e582237

- Arnaldo

Quoted 29 lines

Signed-off-by SeongJae Park <[email protected]>

---
 tools/perf/Documentation/perf-script-python.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

tools/perf/Documentation/perf-script-python.txt +2 -3

index 44e51351536f..f723ce41268c 100644
@@ -530,7 +530,7 @@ can implement a set of optional functions:
 gives scripts a chance to do setup tasks:
 
 ----
-def trace_begin:
+def trace_begin():
     pass
 ----
 

@@ -539,7 +539,7 @@ def trace_begin:
  as display results:
 
 ----
-def trace_end:
+def trace_end():
     pass
 ----
 
--

2.13.0

Default definition of trace_unhandled() has updated while perf-script-python.txt has not updated. This commit updates the document for that.

Signed-off-by SeongJae Park <[email protected]>

Fixes c02514850d67b ("perf scripts python: Give field dict to unhandled callback")

---
 tools/perf/Documentation/perf-script-python.txt | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

tools/perf/Documentation/perf-script-python.txt +3 -6

index f723ce41268c..51ec2d20068a 100644
@@ -149,10 +149,8 @@ def raw_syscalls__sys_enter(event_name, context, common_cpu,
 		print "id=%d, args=%s\n" % \
 		(id, args),
 
-def trace_unhandled(event_name, context, common_cpu, common_secs, common_nsecs,
-		common_pid, common_comm):
-		print_header(event_name, common_cpu, common_secs, common_nsecs,
-		common_pid, common_comm)
+def trace_unhandled(event_name, context, event_fields_dict):
+		print ' '.join(['%s=%s'%(k,str(v))for k,v in sorted(event_fields_dict.items())])
 
 def print_header(event_name, cpu, secs, nsecs, pid, comm):
 	print "%-20s %5u %05u.%09u %8u %-20s " % \

@@ -548,8 +546,7 @@ def trace_end():
  of common arguments are passed into it:
 
 ----
-def trace_unhandled(event_name, context, common_cpu, common_secs,
-        common_nsecs, common_pid, common_comm):
+def trace_unhandled(event_name, context, event_fields_dict):
     pass
 ----
 

Signature · 1 line

2.13.0

This patchset fixes few nitpicks in perf-script code and documents.

SeongJae Park (5):
perf script: Fix outdated comment for perf-trace-python perf-script-python,perl.txt: Fix typos perf-script-python.txt: Polish command examples perf-script-python.txt: Fix wrong code snippets perf-script-python.txt: Apply updated trace_unhandled() definition

tools/perf/Documentation/perf-script-perl.txt      |  2 +-
tools/perf/Documentation/perf-script-python.txt    | 23 +++++++++-------------
.../util/scripting-engines/trace-event-python.c    |  2 +-
3 files changed, 11 insertions(+), 16 deletions(-)

Signature · 1 line

2.13.0