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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 8 May 2017 17:12:43 +0900
From:   Taeung Song <treeze.taeung@...il.com>
To:     SeongJae Park <sj38.park@...il.com>
Cc:     Peter Zijlstra <peterz@...radead.org>,
        Ingo Molnar <mingo@...nel.org>,
        Arnaldo Carvalho de Melo <arnaldo.melo@...il.com>,
        linux-kernel@...r.kernel.org,
        Masami Hiramatsu <mhiramat@...nel.org>,
        Namhyung Kim <namhyung@...nel.org>,
        Jiri Olsa <jolsa@...nel.org>
Subject: Re: [PATCH] perf probe: Fix examples section of documentation

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@...il.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