lkml.org 
[lkml]   [2015]   [Dec]   [1]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    SubjectRe: [PATCH v11 07/24] perf config: Document variables for 'help' section in man page
    From
    Date
    Hi, Namhyung

    > On Nov 18, 2015, at 9:45 AM, Namhyung Kim <namhyung@kernel.org> wrote:
    >
    > On Tue, Nov 17, 2015 at 10:53:27PM +0900, Taeung Song wrote:
    >> Explain 'help.format' and 'help.autocorrect' variables.
    >>
    >> Cc: Namhyung Kim <namhyung@kernel.org>
    >> Cc: Jiri Olsa <jolsa@redhat.com>
    >> Signed-off-by: Taeung Song <treeze.taeung@gmail.com>
    >> ---
    >> tools/perf/Documentation/perf-config.txt | 21 +++++++++++++++++++++
    >> 1 file changed, 21 insertions(+)
    >>
    >> diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
    >> index bfbeb34..88e9b88 100644
    >> --- a/tools/perf/Documentation/perf-config.txt
    >> +++ b/tools/perf/Documentation/perf-config.txt
    >> @@ -242,6 +242,27 @@ annotate.*::
    >>
    >> │1 1382: movb $0x1,-0x270(%rbp)
    >>
    >> +help.*::
    >> + help.format:: = man
    >
    > What is this '= man' part? Is it for default value? It looks inconsistent anyway.
    >
    >
    >> + A format of manual page can be 'man', 'info', 'web' or 'html'.
    >> + 'man' is default.
    >
    > I don't know we support other format of manual pages. Maybe asciidoc
    > does the job for us, but do we really care? At least 'info' seems broken..
    >

    I rechecked source code for this values and tested them.
    Only a ‘man’ value work with perf without any problems.
    And code for ‘web', ‘html’ and ‘info’ has a few errors.

    So, IMHO:), I thought that if the code for them was fixed,
    maybe they could be used as values for help.format.

    Or is it better to remove/disable this values (web, html, info) ?
    (First of all I'll try to make patch for the errors.)


    Thanks,
    Taeung

    >
    >> + help.autocorrect:: = 0
    >> + Automatically correct and execute mistyped commands after
    >> + waiting for the given number of deciseconds (0.1 sec).
    >> + Let's see a example. If a mistyped sub-command is executed like 'perf mistyped-command'
    >
    > s/a example/an example/
    >
    >> + and this option is 0, the output is as below.
    >> +
    >> + perf: 'mistyped-command' is not a perf-command. See 'perf --help'.
    >> +
    >> + Or if this option is more than 1, the output can be such as.
    >> +
    >> + WARNING: You called a perf program named 'mistyped-command', which does not exist.
    >> + Continuing under the assumption that you meant 'with-kcore'
    >> + in 0.1 seconds automatically...
    >> + Usage: perf-with-kcore <perf sub-command> <perf.data directory> [<sub-command options> [ -- <workload>]]
    >> + <perf sub-command> can be record, script, report or inject
    >> + or: perf-with-kcore fix_buildid_cache_permissions
    >
    > I wasn't aware of this feature and it seems completely broken. If
    > it's a leftover from the git codebase, we'd better either to
    > disable/remove it or fix it.
    >
    > Thanks,
    > Namhyung
    >
    >
    >> +
    >> SEE ALSO
    >> --------
    >> linkperf:perf[1]
    >> --
    >> 1.9.1



    \
     
     \ /
      Last update: 2015-12-01 17:41    [W:4.743 / U:0.040 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site