Re: [PATCH] perf probe: Fix examples section of documentation

From: Taeung Song
Date: Mon May 08 2017 - 04:12:56 EST


Hi SeongJae,

Nice to see you :)

On 05/07/2017 07:36 PM, SeongJae Park wrote:
An example in perf-probe documentation for pattern of function name
based probe addition is not providing example command for the case.
This commit fixes the example to give appropriate example command.

Signed-off-by: SeongJae Park <sj38.park@xxxxxxxxx>
---
tools/perf/Documentation/perf-probe.txt | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/tools/perf/Documentation/perf-probe.txt b/tools/perf/Documentation/perf-probe.txt
index e6c9902c6d82..165c2b1d4317 100644
--- a/tools/perf/Documentation/perf-probe.txt
+++ b/tools/perf/Documentation/perf-probe.txt
@@ -240,9 +240,13 @@ Add a probe on schedule() function 12th line with recording cpu local variable:
or
./perf probe --add='schedule:12 cpu'

- this will add one or more probes which has the name start with "schedule".
+Add one or more probes which has the name start with "schedule".

- Add probes on lines in schedule() function which calls update_rq_clock().
+ ./perf probe schedule*
+ or
+ ./perf probe --add='schedule*'
+
+Add probes on lines in schedule() function which calls update_rq_clock().

./perf probe 'schedule;update_rq_clock*'
or


LGTM
As a nitpick, it would be better to add "Fixes:" such as:

Fixes: ee391de876ae ("perf probe: Update perf probe document")

And I added Cc: Masami Hiramatsu related to the line you modified
and Cc: other developers who can review this.

Thanks,
Taeung