Messages in this thread | | | Date | Sun, 19 Apr 2015 12:27:03 +0900 | From | Namhyung Kim <> | Subject | Re: [PATCH 1/2] perf tools: Add 'perf-config' command |
| |
Hi Taeung,
On Sat, Apr 18, 2015 at 02:02:08PM +0900, Taewoong Song wrote: > Hi, Namhyung > > Thanks for your review and advices :) > There is a question which may be weird, followed by > > > On Apr 13, 2015, at 3:16 PM, Namhyung Kim <namhyung@kernel.org> wrote: > > > > Hi Taeung, > > > > On Sun, Apr 12, 2015 at 11:44:48PM +0900, Taeung Song wrote: > >> The perf configuration file contains many variables which can make > >> the perf command's action more effective and more skilful. > >> But looking through state of configuration is difficult and > >> there's no knowing what kind of other variables except variables in perfconfig.example exist. > >> So This patch adds 'perf-config' command with '--all' option and a document for it. > >> > >> Signed-off-by: Taeung Song <treeze.taeung@gmail.com <mailto:treeze.taeung@gmail.com>> > >> --- > > > > Thanks for your work! > > > > I think the documentation updates need to be shared with tools > > manpages, or at least they can point to this document for details. > > This can be further work though. ;-) > > > > Sorry I don’t understand this share very well. > How can I share the documentation with tools manpages ?
I mean you can add a description for some feature to link the config document or vice versa. Many of those description can be added to the tool manpage or cross-reference config option at least.
For example, I sent a patch for children overhead documentation so you can just add 'see perf-report(1) for more details' into the description of the config option instead of repeating the whole contents. Or use asciidoc's 'include' macro to include the (part of) doc directly if possible.
> > And are there people who can help the document to be modified with more detail info ? > Are they contributors for doc ?
Unfortunately, very few people donated their time to improve the documentation until now.
Thanks, Namhyung
| |