Re: [PATCH] perf tools: Fix an error on perf-bench document

[Ingo Molnar <mingo@kernel.org>]

* Namhyung Kim <namhyung@kernel.org> wrote:

> The pipe should be messaging.
> 
> Signed-off-by: Namhyung Kim <namhyung@kernel.org>
> ---
>  tools/perf/Documentation/perf-bench.txt |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/perf/Documentation/perf-bench.txt b/tools/perf/Documentation/perf-bench.txt
> index a3dbadb26ef5..d53d22f0c6ee 100644
> --- a/tools/perf/Documentation/perf-bench.txt
> +++ b/tools/perf/Documentation/perf-bench.txt
> @@ -51,8 +51,8 @@ SUITES FOR 'sched'
>  Suite for evaluating performance of scheduler and IPC mechanisms.
>  Based on hackbench by Rusty Russell.
>  
> -Options of *pipe*
> -^^^^^^^^^^^^^^^^^
> +Options of *messaging*
> +^^^^^^^^^^^^^^^^^^^^^^
>  -p::
>  --pipe::
>  Use pipe() instead of socketpair()
> -- 

There's several typos all across the perf bench documentation:

1)

       This perf bench command is general framework for benchmark suites.

s/is general/is a general

2)

The output of 'perf bench --help' outputs weird looking 
formatting characters like:

           .ft C
           % perf bench sched pipe                      # with no style specified
           (executing 1000000 pipe operations between two tasks)
                   Total time:5.855 sec
                           5.855061 usecs/op
                           170792 ops/sec
           .ft

3)

This:

           all: test all suite (pseudo suite)

s/all suite (psudo suite)/all benchmark suites

(this should be fixed for perf bench mem as well.)

4)

perf bench mem memcpy -h outputs:

    -l, --length <1MB>    Specify length of memory to copy. available unit: B, MB, GB (upper and lower)

bad capitalization: s/. a/. A

s/unit/units

5)

This:

    -c, --clock           Use CPU clock for measuring

should probably clarify why the CPU clock matters and what 
measurement is done otherwise.

Thanks,

	Ingo