perf tools: Document --children option in more detail
Namhyung Kim
maintainerPATCH v3 1/1 perf tools: Document --children option in more detail
As the --children option changes the output of perf report (and perf top) it sometimes confuses users. Add more words and examples to help understanding of the option's behavior - and how to disable it ;-).
--- tools/perf/Documentation/overhead-calculation.txt | 97 +++++++++++++++++++++++ tools/perf/Documentation/perf-report.txt | 4 + tools/perf/Documentation/perf-top.txt | 3 +- 3 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 tools/perf/Documentation/overhead-calculation.txt
tools/perf/Documentation/overhead-calculation.txt new file +97 -0
@@ -0,0 +1,97 @@ +Overhead calculation +-------------------- +The overhead can be shown in two columns as 'Children' and 'Self' when +perf collects callchains. The self overhead is simply calculated by +adding all period values of the entry - usually a function (symbol). +This is the value that perf shows traditionally and sum of all the +self overhead values should be 100%. + +The 'children' overhead is calculated by adding all period values of +the child functions so that it can show the total overhead of the +higher level functions even if they don't directly execute much. +'Children' here means functions that are called from another (parent) +function. + +It might be confusing that the sum of all the 'children' overhead +values exceeds 100% since each of them is already an accumulation of +'self' overhead of its child functions. But with this enabled, users +can find which function has the most overhead even if samples are +spread over the children. + +Consider the following example; there’re three functions like below. + +----------------------- +void foo(void) { + /* something */ +} + +void bar(void) { + /* do something */ + foo(); +} + +int main(void) { + bar() + return 0; +} +----------------------- + +In this case 'foo' is a child of 'bar', and 'bar' is an immediate +child of 'main' so 'foo' also is a child of 'main'. In other words, +'main' is a parent of 'foo' and 'bar', and 'bar' is a parent of 'foo'. + +Suppose all samples are recorded in 'foo' and 'bar' only. When it's +recorded with callchains the output will be shown something like below +in the usual (self-overhead-only) output of perf report: + +---------------------------------- +Overhead Symbol +........ ..................... + 60.00% foo + | + --- foo + bar + main + __libc_start_main + + 40.00% bar + | + --- bar + main + __libc_start_main +---------------------------------- + +When the --children option is enabled, the (self) overhead of children (in +this case foo and bar) are added to the parent to calculate the +children overhead. In this case the report could be displayed as: + +------------------------------------------- +Children Self Symbol +........ ........ .................... + 100.00% 0.00% __libc_start_main + | + --- __libc_start_main + + 100.00% 0.00% main + | + --- main + __libc_start_main + + 100.00% 40.00% bar + | + --- bar + main + __libc_start_main + + 60.00% 60.00% foo + | + --- foo + bar + main + __libc_start_main +------------------------------------------- + +Since v3.16 the children overhead is shown by default and the output +is sorted by the values. Children overhead is disabled by specifying +--no-children option on the command line or by adding 'report.children += false' or 'top.children = false' in the perf config file.
tools/perf/Documentation/perf-report.txt +4 -0
@@ -193,6 +193,7 @@ OPTIONS Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires callchains are recorded. + See the `overhead calculation' section for more details. --max-stack:: Set the stack depth limit when parsing the callchain, anything
@@ -323,6 +324,9 @@ OPTIONS --header-only:: Show only perf.data header (forces --stdio). + +include::overhead-calculation.txt[] + SEE ALSO -------- linkperf:perf-stat[1], linkperf:perf-annotate[1]
tools/perf/Documentation/perf-top.txt +2 -1
@@ -168,7 +168,7 @@ Default is to monitor all CPUS. Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires -g/--call-graph option - enabled. + enabled. See the `overhead calculation' section for more details. --max-stack:: Set the stack depth limit when parsing the callchain, anything
@@ -234,6 +234,7 @@ INTERACTIVE PROMPTING KEYS Pressing any unmapped key displays a menu, and prompts for input. +include::overhead-calculation.txt[] SEE ALSO --------
Signature · 1 line
2.3.5
Arnaldo Carvalho de Melo
maintainerEm Tue, Apr 21, 2015 at 09:28:31PM +0900, Namhyung Kim escreveu:
tools/perf/Documentation/overhead-calculation.txt
Quoted 19 lines
As the --children option changes the output of perf report (and perf top) it sometimes confuses users. Add more words and examples to help understanding of the option's behavior - and how to disable it ;-).
Reviewed-by Ingo Molnar <[email protected]>Cc Taeung Song <[email protected]>Signed-off-by Namhyung Kim <[email protected]>--- tools/perf/Documentation/overhead-calculation.txt | 97 +++++++++++++++++++++++ tools/perf/Documentation/perf-report.txt | 4 + tools/perf/Documentation/perf-top.txt | 3 +- 3 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 tools/perf/Documentation/overhead-calculation.txttools/perf/Documentation/overhead-calculation.txt new file +0
-0
I think Ingo suggested that you renamed this file to include the word "callchain" in it, no? looking at "overhead-calculation" I feel like I first have to open it to figure out what kind of overhead is this, perhaps it would be better named:
tools/perf/Documentation/callchain-overhead.txt
?
- Arnaldo
tools/perf/Documentation/overhead-calculation.txt line 7
Quoted 8 lines
tools/perf/Documentation/overhead-calculation.txt new file +7
-0@@ -0,0 +1,97 @@ +Overhead calculation +-------------------- +The overhead can be shown in two columns as 'Children' and 'Self' when +perf collects callchains. The self overhead is simply calculated by +adding all period values of the entry - usually a function (symbol). +This is the value that perf shows traditionally and sum of all the +self overhead values should be 100%.
For consistency sake, please use always 'self' instead of it without quotes, like you do in the next paragraph for 'children'.
tools/perf/Documentation/overhead-calculation.txt line 16
Quoted 8 lines
tools/perf/Documentation/overhead-calculation.txt new file +8
-0+The 'children' overhead is calculated by adding all period values of +the child functions so that it can show the total overhead of the +higher level functions even if they don't directly execute much. +'Children' here means functions that are called from another (parent) +function. + +It might be confusing that the sum of all the 'children' overhead +values exceeds 100% since each of them is already an accumulation of
Just like you do in the next line:
tools/perf/Documentation/overhead-calculation.txt line 21
Quoted 6 lines
tools/perf/Documentation/overhead-calculation.txt new file +5
-0+'self' overhead of its child functions. But with this enabled, users +can find which function has the most overhead even if samples are +spread over the children. + +Consider the following example; there’re three functions like below.
Humm, "there are", no? Else I'm learning something new here...
Googled, some controversy,
http://grammar.about.com/od/words/a/EnglishContractions.htm doesn't list it as a "common contraction", to name just one of the sites, anyway, found it unfamiliar:
In the kernel sources:
[acme@zoo linux]$ find . -type f | xargs grep -i "there're" | wc -l 15
[acme@zoo linux]$ find . -type f | xargs grep -i "there are" | wc -l 5343
[acme@zoo linux]$
Quoted 13 lines
tools/perf/Documentation/overhead-calculation.txt new file +13
-0+ +----------------------- +void foo(void) { + /* something */ +} + +void bar(void) { + /* do something */ + foo(); +} + +int main(void) { + bar()
tools/perf/Documentation/overhead-calculation.txt line 44
Quoted 10 lines
tools/perf/Documentation/overhead-calculation.txt new file +10
-0+ return 0; +} +----------------------- + +In this case 'foo' is a child of 'bar', and 'bar' is an immediate +child of 'main' so 'foo' also is a child of 'main'. In other words, +'main' is a parent of 'foo' and 'bar', and 'bar' is a parent of 'foo'. + +Suppose all samples are recorded in 'foo' and 'bar' only. When it's +recorded with callchains the output will be shown something like below
will show something like
Quoted 11 lines
tools/perf/Documentation/overhead-calculation.txt new file +11
-0+in the usual (self-overhead-only) output of perf report: + +---------------------------------- +Overhead Symbol +........ ..................... + 60.00% foo + | + --- foo + bar + main + __libc_start_main
tools/perf/Documentation/overhead-calculation.txt line 65
Quoted 10 lines
tools/perf/Documentation/overhead-calculation.txt new file +10
-0+ + 40.00% bar + | + --- bar + main + __libc_start_main +---------------------------------- + +When the --children option is enabled, the (self) overhead of children (in +this case foo and bar) are added to the parent to calculate the
is
Quoted 20 lines
tools/perf/Documentation/overhead-calculation.txt new file +20
-0+children overhead. In this case the report could be displayed as: + +------------------------------------------- +Children Self Symbol +........ ........ .................... + 100.00% 0.00% __libc_start_main + | + --- __libc_start_main + + 100.00% 0.00% main + | + --- main + __libc_start_main + + 100.00% 40.00% bar + | + --- bar + main + __libc_start_main +
tools/perf/Documentation/overhead-calculation.txt line 95
Quoted 10 lines
tools/perf/Documentation/overhead-calculation.txt new file +10
-0+ 60.00% 60.00% foo + | + --- foo + bar + main + __libc_start_main +------------------------------------------- + +Since v3.16 the children overhead is shown by default and the output +is sorted by the values. Children overhead is disabled by specifying
'the values'? Which ones, maybe rephrase as 'its
values', i.e. the "parent + children total overhead" value?
Quoted 2 lines
+--no-children option on the command line or by adding 'report.children += false' or 'top.children = false' in the perf config file.
One can as well use the OPTION_FOO shortening mechanism and instead use:
perf report --no-ch
Which is enough to disambiguate it from "--no-column-widths" and "--no-cpu".
tools/perf/Documentation/perf-report.txt OPTIONS · line 196
Quoted 9 lines
tools/perf/Documentation/perf-report.txt +1
-0@@ -193,6 +193,7 @@ OPTIONS Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires callchains are recorded. + See the `overhead calculation' section for more details.
`callchain overhead'
tools/perf/Documentation/perf-report.txt OPTIONS · line 328
Quoted 9 lines
tools/perf/Documentation/perf-report.txt +2
-0--max-stack:: Set the stack depth limit when parsing the callchain, anything@@ -323,6 +324,9 @@ OPTIONS --header-only:: Show only perf.data header (forces --stdio). + +include::overhead-calculation.txt[]
+include::callchain-overhead.txt
Quoted 9 lines
tools/perf/Documentation/perf-report.txt +1
-0+ SEE ALSO -------- linkperf:perf-stat[1], linkperf:perf-annotate[1]tools/perf/Documentation/perf-top.txt +0
-0
tools/perf/Documentation/perf-top.txt Default is to monitor all CPUS. · line 171
Quoted 5 lines
tools/perf/Documentation/perf-top.txt +1
-1@@ -168,7 +168,7 @@ Default is to monitor all CPUS. Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires -g/--call-graph option - enabled. + enabled. See the `overhead calculation' section for more details.
ditto.
tools/perf/Documentation/perf-top.txt INTERACTIVE PROMPTING KEYS · line 237
Quoted 8 lines
tools/perf/Documentation/perf-top.txt +1
-0--max-stack:: Set the stack depth limit when parsing the callchain, anything@@ -234,6 +234,7 @@ INTERACTIVE PROMPTING KEYS Pressing any unmapped key displays a menu, and prompts for input. +include::overhead-calculation.txt[]
Ditto.
Quoted 5 lines
tools/perf/Documentation/perf-top.txt +0
-0SEE ALSO --------Signature · 1 line
2.3.5
Namhyung Kim
maintainerHi Arnaldo,
Quoted 26 lines · Arnaldo Carvalho de Melo
Em Tue, Apr 21, 2015 at 09:28:31PM +0900, Namhyung Kim escreveu:
tools/perf/Documentation/overhead-calculation.txt
Quoted 19 lines
As the --children option changes the output of perf report (and perf top) it sometimes confuses users. Add more words and examples to help understanding of the option's behavior - and how to disable it ;-).
Reviewed-by Ingo Molnar <[email protected]>Cc Taeung Song <[email protected]>Signed-off-by Namhyung Kim <[email protected]>--- tools/perf/Documentation/overhead-calculation.txt | 97 +++++++++++++++++++++++ tools/perf/Documentation/perf-report.txt | 4 + tools/perf/Documentation/perf-top.txt | 3 +- 3 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 tools/perf/Documentation/overhead-calculation.txttools/perf/Documentation/overhead-calculation.txt new file +0
-0I think Ingo suggested that you renamed this file to include the word "callchain" in it, no? looking at "overhead-calculation" I feel like I first have to open it to figure out what kind of overhead is this, perhaps it would be better named:
Quoted 3 lines
tools/perf/Documentation/callchain-overhead.txt?
Please see my reply to the Ingo's post. I think he agreed on this name.
Quoted 14 lines
- Arnaldo
tools/perf/Documentation/overhead-calculation.txt line 7
Quoted 8 lines
tools/perf/Documentation/overhead-calculation.txt new file +7
-0@@ -0,0 +1,97 @@ +Overhead calculation +-------------------- +The overhead can be shown in two columns as 'Children' and 'Self' when +perf collects callchains. The self overhead is simply calculated by +adding all period values of the entry - usually a function (symbol). +This is the value that perf shows traditionally and sum of all the +self overhead values should be 100%.For consistency sake, please use always 'self' instead of it without quotes, like you do in the next paragraph for 'children'.
OK.
Quoted 26 lines
tools/perf/Documentation/overhead-calculation.txt line 16
Quoted 9 lines
tools/perf/Documentation/overhead-calculation.txt new file +8
-0+The 'children' overhead is calculated by adding all period values of +the child functions so that it can show the total overhead of the +higher level functions even if they don't directly execute much. +'Children' here means functions that are called from another (parent) +function. + +It might be confusing that the sum of all the 'children' overhead +values exceeds 100% since each of them is already an accumulation ofJust like you do in the next line:
tools/perf/Documentation/overhead-calculation.txt line 21
Quoted 6 lines
tools/perf/Documentation/overhead-calculation.txt new file +5
-0+'self' overhead of its child functions. But with this enabled, users +can find which function has the most overhead even if samples are +spread over the children. + +Consider the following example; there’re three functions like below.Humm, "there are", no? Else I'm learning something new here...
Googled, some controversy,
http://grammar.about.com/od/words/a/EnglishContractions.htm doesn't list it as a "common contraction", to name just one of the sites, anyway, found it unfamiliar:
Quoted 7 lines
In the kernel sources:
[acme@zoo linux]$ find . -type f | xargs grep -i "there're" | wc -l 15
[acme@zoo linux]$ find . -type f | xargs grep -i "there are" | wc -l 5343
[acme@zoo linux]$
Will change.
Quoted 18 lines
Quoted 18 lines
tools/perf/Documentation/overhead-calculation.txt new file +17
-0+ +----------------------- +void foo(void) { + /* something */ +} + +void bar(void) { + /* do something */ + foo(); +} + +int main(void) { + bar() + return 0; +} +----------------------- +
Quoted 8 lines
tools/perf/Documentation/overhead-calculation.txt line 44
Quoted 6 lines
tools/perf/Documentation/overhead-calculation.txt new file +6
-0+In this case 'foo' is a child of 'bar', and 'bar' is an immediate +child of 'main' so 'foo' also is a child of 'main'. In other words, +'main' is a parent of 'foo' and 'bar', and 'bar' is a parent of 'foo'. + +Suppose all samples are recorded in 'foo' and 'bar' only. When it's +recorded with callchains the output will be shown something like belowwill show something like
OK
Quoted 14 lines
Quoted 14 lines
tools/perf/Documentation/overhead-calculation.txt new file +14
-0+in the usual (self-overhead-only) output of perf report: + +---------------------------------- +Overhead Symbol +........ ..................... + 60.00% foo + | + --- foo + bar + main + __libc_start_main + + 40.00% bar + |
Quoted 8 lines
tools/perf/Documentation/overhead-calculation.txt line 65
Quoted 7 lines
tools/perf/Documentation/overhead-calculation.txt new file +7
-0+ --- bar + main + __libc_start_main +---------------------------------- + +When the --children option is enabled, the (self) overhead of children (in +this case foo and bar) are added to the parent to calculate theis
Hmm.. shouldn't it be "the 'self' overhead values of child functions are ..."?
Quoted 24 lines
Quoted 24 lines
tools/perf/Documentation/overhead-calculation.txt new file +24
-0+children overhead. In this case the report could be displayed as: + +------------------------------------------- +Children Self Symbol +........ ........ .................... + 100.00% 0.00% __libc_start_main + | + --- __libc_start_main + + 100.00% 0.00% main + | + --- main + __libc_start_main + + 100.00% 40.00% bar + | + --- bar + main + __libc_start_main + + 60.00% 60.00% foo + | + --- foo + bar
Quoted 8 lines
tools/perf/Documentation/overhead-calculation.txt line 95
Quoted 6 lines
tools/perf/Documentation/overhead-calculation.txt new file +6
-0+ main + __libc_start_main +------------------------------------------- + +Since v3.16 the children overhead is shown by default and the output +is sorted by the values. Children overhead is disabled by specifying'the values'? Which ones, maybe rephrase as 'its
values', i.e. the "parent + children total overhead" value?
OK. I thought 'the values' means the children overhead values as we mentioned it right before. Anyway, it'd be better to have clear words in the manpage.
Quoted 8 lines
Quoted 2 lines
+--no-children option on the command line or by adding 'report.children += false' or 'top.children = false' in the perf config file.One can as well use the
OPTION_FOOshortening mechanism and instead use:perf report --no-chWhich is enough to disambiguate it from "--no-column-widths" and "--no-cpu".
Are you saying that you want to add the short form instead of the full --no-chlidren name? I think we need to verbose in the manpage at least and it might not work in the future if some --chxxx option is added.
Quoted 12 lines
tools/perf/Documentation/perf-report.txt OPTIONS · line 196
Quoted 10 lines
tools/perf/Documentation/perf-report.txt +1
-0@@ -193,6 +193,7 @@ OPTIONS Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires callchains are recorded. + See the `overhead calculation' section for more details.`callchain overhead'
Do you prefer this name to 'overhead calculation'? For me, it looks like saying about how much overhead will be added if we enabled callchains at perf record time or processing them at perf report time.
Thanks,
Namhyung
Quoted 46 lines
tools/perf/Documentation/perf-report.txt OPTIONS · line 328
Quoted 10 lines
tools/perf/Documentation/perf-report.txt +2
-0--max-stack:: Set the stack depth limit when parsing the callchain, anything@@ -323,6 +324,9 @@ OPTIONS --header-only:: Show only perf.data header (forces --stdio). + +include::overhead-calculation.txt[]+include::callchain-overhead.txt
Quoted 9 lines
tools/perf/Documentation/perf-report.txt +1
-0+ SEE ALSO -------- linkperf:perf-stat[1], linkperf:perf-annotate[1]tools/perf/Documentation/perf-top.txt +0
-0tools/perf/Documentation/perf-top.txt Default is to monitor all CPUS. · line 171
Quoted 5 lines
tools/perf/Documentation/perf-top.txt +1
-1@@ -168,7 +168,7 @@ Default is to monitor all CPUS. Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires -g/--call-graph option - enabled. + enabled. See the `overhead calculation' section for more details.ditto.
tools/perf/Documentation/perf-top.txt INTERACTIVE PROMPTING KEYS · line 237
Quoted 8 lines
tools/perf/Documentation/perf-top.txt +1
-0--max-stack:: Set the stack depth limit when parsing the callchain, anything@@ -234,6 +234,7 @@ INTERACTIVE PROMPTING KEYS Pressing any unmapped key displays a menu, and prompts for input. +include::overhead-calculation.txt[]Ditto.
Quoted 5 lines
tools/perf/Documentation/perf-top.txt +0
-0SEE ALSO --------Signature · 1 line
2.3.5
Arnaldo Carvalho de Melo
maintainerEm Wed, Apr 22, 2015 at 01:16:29AM +0900, Namhyung Kim escreveu:
Quoted 11 lines · Arnaldo Carvalho de Melo
Quoted 8 lines
Quoted 1 line
+++
b/tools/perf/Documentation/overhead-calculation.txtI think Ingo suggested that you renamed this file to include the word "callchain" in it, no? looking at "overhead-calculation" I feel like I first have to open it to figure out what kind of overhead is this, perhaps it would be better named:
tools/perf/Documentation/callchain-overhead.txt
?Please see my reply to the Ingo's post. I think he agreed on this name.
I still find it confusing for the file name, where there is no context, from just the file name when one does a 'ls tools/perf/Documentatoin' to figure out about what overhead that is referring to.
So, perhaps a longer name:
tools/perf/Documentation/callchain-overhead-calculation.txt
?
Inside perf-{record,top}.txt, yeah, we have context, we know that this is about post processing, formatting, etc.
<SNIP>
Quoted 5 lines
Quoted 5 lines
Quoted 2 lines
+--no-children option on the command line or by adding 'report.children += false' or 'top.children = false' in the perf config file.One can as well use the
OPTION_FOOshortening mechanism and instead use:
Quoted 8 lines
Quoted 3 lines
perf report --no-chWhich is enough to disambiguate it from "--no-column-widths" and "--no-cpu".
Are you saying that you want to add the short form instead of the full --no-chlidren name? I think we need to verbose in the manpage at least and it might not work in the future if some --chxxx option is added.
Perhaps:
"--no-children option on the command line or by adding 'report.children = false' or 'top.children = false' in the perf config file.
A shorter form on the command line can be used, for instance '--no-ch' is unambiguous at the time of this writing."
Quoted 12 lines
Quoted 11 lines
tools/perf/Documentation/perf-report.txt OPTIONS · line 196
Quoted 9 lines
tools/perf/Documentation/perf-report.txt +1
-0@@ -193,6 +193,7 @@ OPTIONS Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires callchains are recorded. + See the `overhead calculation' section for more details.`callchain overhead'
Quoted 1 line
Do you prefer this name to 'overhead calculation'? For me, it looks
It is ok with me "overhead calculation", as mentioned previously in this message, the context in this perf-report.txt file should make it clear that the overhead is about callchains.
Quoted 2 lines
like saying about how much overhead will be added if we enabled callchains at perf record time or processing them at perf report time.
Ok.
- Arnaldo
Namhyung Kim
maintainerHi Arnaldo,
Quoted 17 lines · Arnaldo Carvalho de Melo
Em Wed, Apr 22, 2015 at 01:16:29AM +0900, Namhyung Kim escreveu:
Quoted 11 lines · Arnaldo Carvalho de Melo
Quoted 8 lines
Quoted 1 line
+++
b/tools/perf/Documentation/overhead-calculation.txtI think Ingo suggested that you renamed this file to include the word "callchain" in it, no? looking at "overhead-calculation" I feel like I first have to open it to figure out what kind of overhead is this, perhaps it would be better named:
tools/perf/Documentation/callchain-overhead.txt
?Please see my reply to the Ingo's post. I think he agreed on this name.
I still find it confusing for the file name, where there is no context, from just the file name when one does a 'ls
tools/perf/Documentatoin' to figure out about what overhead that is referring to.
Quoted 5 lines
So, perhaps a longer name:
tools/perf/Documentation/callchain-overhead-calculation.txt?
OK, will change.
Quoted 3 lines
Inside perf-{record,top}.txt, yeah, we have context, we know that this is about post processing, formatting, etc.
Right.
Quoted 17 lines
<SNIP>
Quoted 5 lines
Quoted 5 lines
Quoted 2 lines
+--no-children option on the command line or by adding 'report.children += false' or 'top.children = false' in the perf config file.One can as well use the
OPTION_FOOshortening mechanism and instead use:Quoted 8 lines
Quoted 3 lines
perf report --no-chWhich is enough to disambiguate it from "--no-column-widths" and "--no-cpu".
Are you saying that you want to add the short form instead of the full --no-chlidren name? I think we need to verbose in the manpage at least and it might not work in the future if some --chxxx option is added.
Quoted 7 lines
Perhaps:
"--no-children option on the command line or by adding 'report.children = false' or 'top.children = false' in the perf config file.
A shorter form on the command line can be used, for instance '--no-ch' is unambiguous at the time of this writing."
I don't think it belongs here. The shorter form is not only for the --children, so it should be described in different place.
Quoted 13 lines
Quoted 13 lines
Quoted 12 lines
tools/perf/Documentation/perf-report.txt OPTIONS · line 196
Quoted 10 lines
tools/perf/Documentation/perf-report.txt +1
-0@@ -193,6 +193,7 @@ OPTIONS Accumulate callchain of children to parent entry so that then can show up in the output. The output will have a new "Children" column and will be sorted on the data. It requires callchains are recorded. + See the `overhead calculation' section for more details.`callchain overhead'
Quoted 5 lines
Quoted 1 line
Do you prefer this name to 'overhead calculation'? For me, it looks
It is ok with me "overhead calculation", as mentioned previously in this message, the context in this perf-report.txt file should make it clear that the overhead is about callchains.
OK, I'll leave it as is.
Thanks,
Namhyung
Quoted 7 lines
Quoted 3 lines
like saying about how much overhead will be added if we enabled callchains at perf record time or processing them at perf report time.
Ok.
- Arnaldo
Arnaldo Carvalho de Melo
maintainerEm Wed, Apr 22, 2015 at 03:09:06PM +0900, Namhyung Kim escreveu:
Quoted 17 lines · Arnaldo Carvalho de Melo
Quoted 15 lines
Quoted 5 lines
Quoted 4 lines
Quoted 2 lines
+--no-children option on the command line or by adding 'report.children += false' or 'top.children = false' in the perf config file.One can as well use the
OPTION_FOOshortening mechanism and instead use:Quoted 8 lines
Quoted 3 lines
perf report --no-chWhich is enough to disambiguate it from "--no-column-widths" and "--no-cpu".
Are you saying that you want to add the short form instead of the full --no-chlidren name? I think we need to verbose in the manpage at least and it might not work in the future if some --chxxx option is added.
Perhaps:
Quoted 8 lines
Quoted 5 lines
"--no-children option on the command line or by adding 'report.children = false' or 'top.children = false' in the perf config file.
A shorter form on the command line can be used, for instance '--no-ch' is unambiguous at the time of this writing."
I don't think it belongs here. The shorter form is not only for the --children, so it should be described in different place.
Well, I continue thinking it would add value, as the possibility of shortening overly long options, like '--no-children' to reduce typing, is handy, mentioning this possibility here and there, when such long option names appears, would be of help.
But I won't insist, thanks for addressing the other suggestions, applying.
- Arnaldo