* [PATCH] perf probe: Fix examples section of documentation
@ 2017-05-07 10:36 SeongJae Park
2017-05-08 8:12 ` Taeung Song
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: SeongJae Park @ 2017-05-07 10:36 UTC (permalink / raw)
To: peterz, mingo, acme; +Cc: linux-kernel, SeongJae Park
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@gmail.com>
---
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
--
2.12.0
^ permalink raw reply related [flat|nested] 5+ messages in thread* Re: [PATCH] perf probe: Fix examples section of documentation
2017-05-07 10:36 [PATCH] perf probe: Fix examples section of documentation SeongJae Park
@ 2017-05-08 8:12 ` Taeung Song
2017-05-08 15:19 ` Masami Hiramatsu
2017-06-08 22:46 ` [tip:perf/urgent] " tip-bot for SeongJae Park
2 siblings, 0 replies; 5+ messages in thread
From: Taeung Song @ 2017-05-08 8:12 UTC (permalink / raw)
To: SeongJae Park
Cc: Peter Zijlstra, Ingo Molnar, Arnaldo Carvalho de Melo,
linux-kernel, Masami Hiramatsu, Namhyung Kim, Jiri Olsa
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@gmail.com>
> ---
> 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
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH] perf probe: Fix examples section of documentation
2017-05-07 10:36 [PATCH] perf probe: Fix examples section of documentation SeongJae Park
2017-05-08 8:12 ` Taeung Song
@ 2017-05-08 15:19 ` Masami Hiramatsu
2017-05-08 16:30 ` Arnaldo Carvalho de Melo
2017-06-08 22:46 ` [tip:perf/urgent] " tip-bot for SeongJae Park
2 siblings, 1 reply; 5+ messages in thread
From: Masami Hiramatsu @ 2017-05-08 15:19 UTC (permalink / raw)
To: SeongJae Park; +Cc: peterz, mingo, acme, linux-kernel
On Sun, 7 May 2017 19:36:42 +0900
SeongJae Park <sj38.park@gmail.com> 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@gmail.com>
Good catch!
Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
Thank you!
> ---
> 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
> --
> 2.12.0
>
--
Masami Hiramatsu <mhiramat@kernel.org>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] perf probe: Fix examples section of documentation
2017-05-08 15:19 ` Masami Hiramatsu
@ 2017-05-08 16:30 ` Arnaldo Carvalho de Melo
0 siblings, 0 replies; 5+ messages in thread
From: Arnaldo Carvalho de Melo @ 2017-05-08 16:30 UTC (permalink / raw)
To: Masami Hiramatsu
Cc: SeongJae Park, Peter Zijlstra, Taeung Song, Ingo Molnar, linux-kernel
Em Tue, May 09, 2017 at 12:19:57AM +0900, Masami Hiramatsu escreveu:
> On Sun, 7 May 2017 19:36:42 +0900
> SeongJae Park <sj38.park@gmail.com> 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@gmail.com>
>
> Good catch!
>
> Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
Thanks, I added the suggested Fixes: tag,
- Arnaldo
> Thank you!
>
> > ---
> > 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
> > --
> > 2.12.0
> >
>
>
> --
> Masami Hiramatsu <mhiramat@kernel.org>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [tip:perf/urgent] perf probe: Fix examples section of documentation
2017-05-07 10:36 [PATCH] perf probe: Fix examples section of documentation SeongJae Park
2017-05-08 8:12 ` Taeung Song
2017-05-08 15:19 ` Masami Hiramatsu
@ 2017-06-08 22:46 ` tip-bot for SeongJae Park
2 siblings, 0 replies; 5+ messages in thread
From: tip-bot for SeongJae Park @ 2017-06-08 22:46 UTC (permalink / raw)
To: linux-tip-commits
Cc: tglx, sj38.park, peterz, mingo, mhiramat, linux-kernel, hpa,
acme, treeze.taeung
Commit-ID: d89269a89ebb6a74512f3f40e89cd12017f60a75
Gitweb: http://git.kernel.org/tip/d89269a89ebb6a74512f3f40e89cd12017f60a75
Author: SeongJae Park <sj38.park@gmail.com>
AuthorDate: Sun, 7 May 2017 19:36:42 +0900
Committer: Arnaldo Carvalho de Melo <acme@redhat.com>
CommitDate: Wed, 7 Jun 2017 20:23:11 -0300
perf probe: Fix examples section of documentation
An example in perf-probe documentation for pattern of function name
based probe addition is not providing example command for that case.
This commit fixes the example to give appropriate example command.
Signed-off-by: SeongJae Park <sj38.park@gmail.com>
Acked-by: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Taeung Song <treeze.taeung@gmail.com>
Fixes: ee391de876ae ("perf probe: Update perf probe document")
Link: http://lkml.kernel.org/r/20170507103642.30560-1-sj38.park@gmail.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
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 e6c9902..165c2b1 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
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2017-06-08 22:51 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-07 10:36 [PATCH] perf probe: Fix examples section of documentation SeongJae Park
2017-05-08 8:12 ` Taeung Song
2017-05-08 15:19 ` Masami Hiramatsu
2017-05-08 16:30 ` Arnaldo Carvalho de Melo
2017-06-08 22:46 ` [tip:perf/urgent] " tip-bot for SeongJae Park
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).