Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755073AbbKRApe (ORCPT ); Tue, 17 Nov 2015 19:45:34 -0500 Received: from LGEAMRELO13.lge.com ([156.147.23.53]:59643 "EHLO lgeamrelo13.lge.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752555AbbKRApc convert rfc822-to-8bit (ORCPT ); Tue, 17 Nov 2015 19:45:32 -0500 X-Original-SENDERIP: 156.147.1.151 X-Original-MAILFROM: namhyung@kernel.org X-Original-SENDERIP: 165.244.98.150 X-Original-MAILFROM: namhyung@kernel.org X-Original-SENDERIP: 10.177.227.17 X-Original-MAILFROM: namhyung@kernel.org Date: Wed, 18 Nov 2015 09:45:20 +0900 From: Namhyung Kim To: Taeung Song CC: Arnaldo Carvalho de Melo , linux-kernel@vger.kernel.org, Ingo Molnar , Jiri Olsa Subject: Re: [PATCH v11 07/24] perf config: Document variables for 'help' section in man page Message-ID: <20151118004520.GF7062@sejong> References: <1447768424-17327-1-git-send-email-treeze.taeung@gmail.com> <1447768424-17327-7-git-send-email-treeze.taeung@gmail.com> MIME-Version: 1.0 In-Reply-To: <1447768424-17327-7-git-send-email-treeze.taeung@gmail.com> User-Agent: Mutt/1.5.24 (2015-08-30) X-MIMETrack: Itemize by SMTP Server on LGEKRMHUB06/LGE/LG Group(Release 8.5.3FP6|November 21, 2013) at 2015/11/18 09:45:23, Serialize by Router on LGEKRMHUB06/LGE/LG Group(Release 8.5.3FP6|November 21, 2013) at 2015/11/18 09:45:23 Content-Type: text/plain; charset="utf-8" Content-Disposition: inline Content-Transfer-Encoding: 8BIT Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2429 Lines: 71 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.. > + 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/