Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755782AbbLAQR7 (ORCPT ); Tue, 1 Dec 2015 11:17:59 -0500 Received: from mail-pa0-f44.google.com ([209.85.220.44]:34317 "EHLO mail-pa0-f44.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755296AbbLAQR6 convert rfc822-to-8bit (ORCPT ); Tue, 1 Dec 2015 11:17:58 -0500 Content-Type: text/plain; charset=utf-8 Mime-Version: 1.0 (Mac OS X Mail 9.0 $3094$) Subject: Re: [PATCH v11 07/24] perf config: Document variables for 'help' section in man page From: Taeung Song In-Reply-To: <20151118004520.GF7062@sejong> Date: Wed, 2 Dec 2015 01:17:53 +0900 Cc: Arnaldo Carvalho de Melo , "linux-kernel@vger.kernel.org" , Ingo Molnar , Jiri Olsa Content-Transfer-Encoding: 8BIT Message-Id: <3244FE1E-D2D7-4F53-917A-A7832119615A@gmail.com> References: <1447768424-17327-1-git-send-email-treeze.taeung@gmail.com> <1447768424-17327-7-git-send-email-treeze.taeung@gmail.com> <20151118004520.GF7062@sejong> To: Namhyung Kim X-Mailer: Apple Mail (2.3094) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 3031 Lines: 90 Hi, Namhyung > On Nov 18, 2015, at 9:45 AM, Namhyung Kim wrote: > > On Tue, Nov 17, 2015 at 10:53:27PM +0900, Taeung Song wrote: >> Explain 'help.format' and 'help.autocorrect' variables. >> >> Cc: Namhyung Kim >> Cc: Jiri Olsa >> Signed-off-by: Taeung Song >> --- >> 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 [ [ -- ]] >> + 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 -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/