Menu
▾
▴
[Valgrind-developers] [valgrind] Flip the default value of `--auto` and `--show-percs` to `yes`.
|
From: Nicholas N. <nj...@so...> - 2020-02-20 22:53:25
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=40ab2f14db75244fa791ea99b52f817f018d88ef commit 40ab2f14db75244fa791ea99b52f817f018d88ef Author: Nicholas Nethercote <nne...@mo...> Date: Mon Feb 17 09:40:26 2020 +1100 Flip the default value of `--auto` and `--show-percs` to `yes`. In both `cg_annotate` and `callgrind_annotate`. Diff: --- NEWS | 7 +++++++ cachegrind/cg_annotate.in | 8 ++++---- cachegrind/docs/cg-manual.xml | 20 ++++++++++---------- cachegrind/tests/ann1.vgtest | 2 +- cachegrind/tests/ann2.vgtest | 2 +- callgrind/callgrind_annotate.in | 8 ++++---- callgrind/docs/cl-manual.xml | 4 ++-- callgrind/tests/ann1.vgtest | 2 +- callgrind/tests/ann2.vgtest | 2 +- 9 files changed, 31 insertions(+), 24 deletions(-) diff --git a/NEWS b/NEWS index 07dd914..5dbb014 100644 --- a/NEWS +++ b/NEWS @@ -35,7 +35,14 @@ support for X86/macOS 10.13, AMD64/macOS 10.13 and nanoMIPS/Linux. * Cachegrind: + - cg_annotate's --auto and --show-percs options now default to 'yes', because + they are usually wanted. + * Callgrind: + + - callgrind_annotate's --auto and --show-percs options now default to 'yes', + because they are usually wanted. + - The command option --collect-systime has been enhanced to specify the unit used to record the elapsed time spent during system calls. The command option now accepts the values no|yes|msec|usec|nsec, diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index 1daa15d..fea114b 100644 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -123,11 +123,11 @@ my $default_threshold = 0.1; my $single_threshold = $default_threshold; # If on, show a percentage for each non-zero count. -my $show_percs = 0; +my $show_percs = 1; # If on, automatically annotates all files that are involved in getting over # all the threshold counts. -my $auto_annotate = 0; +my $auto_annotate = 1; # Number of lines to show around each annotated line. my $context = 8; @@ -152,9 +152,9 @@ usage: cg_annotate [options] cachegrind-out-file [source-files...] --sort=A,B,C sort columns by events A,B,C [event column order] --threshold=<0--20> a function is shown if it accounts for more than x% of the counts of the primary sort event [$default_threshold] - --show-percs=yes|no show a percentage for each non-zero count + --show-percs=yes|no show a percentage for each non-zero count [yes] --auto=yes|no annotate all source files containing functions - that helped reach the event count threshold [no] + that helped reach the event count threshold [yes] --context=N print N lines of context before and after annotated lines [8] -I<d> --include=<d> add <d> to list of directories to search for diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml index d90a3be..73b58b6 100644 --- a/cachegrind/docs/cg-manual.xml +++ b/cachegrind/docs/cg-manual.xml @@ -368,16 +368,16 @@ and from libraries (e.g. <filename>getc.c</filename>)</para> <sect2 id="cg-manual.line-by-line" xreflabel="Line-by-line Counts"> <title>Line-by-line Counts</title> -<para>There are two ways to annotate source files -- by specifying them -manually as arguments to cg_annotate, or with the -<option>--auto=yes</option> option. For example, the output from running -<filename>cg_annotate <filename> concord.c</filename> for our example -produces the same output as above followed by an annotated version of -<filename>concord.c</filename>, a section of which looks like:</para> +<para>By default, all source code annotation is also shown. (Filenames to be +annotated can also by specified manually as arguments to cg_annotate, but this +is rarely needed.) For example, the output from running <filename>cg_annotate +<filename> </filename> for our example produces the same output as above +followed by an annotated version of <filename>concord.c</filename>, a section +of which looks like:</para> <programlisting><![CDATA[ -------------------------------------------------------------------------------- --- User-annotated source: concord.c +-- Auto-annotated source: concord.c -------------------------------------------------------------------------------- Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw @@ -437,7 +437,7 @@ part of a file the shown code comes from, eg:</para> controlled by the <option>--context</option> option.</para> -<para>To get automatic annotation, use the <option>--auto=yes</option> option. +<para>Automatic annotation is enabled by default. cg_annotate will automatically annotate every source file it can find that is mentioned in the function-by-function summary. Therefore, the files chosen for auto-annotation are affected by @@ -946,7 +946,7 @@ small differences like these; it works in the same way as <varlistentry> <term> - <option><![CDATA[--show-percs=<no|yes> [default: no] ]]></option> + <option><![CDATA[--show-percs=<no|yes> [default: yes] ]]></option> </term> <listitem> <para>When enabled, a percentage is printed next to all event counts. @@ -957,7 +957,7 @@ small differences like these; it works in the same way as <varlistentry> <term> - <option><![CDATA[--auto=<no|yes> [default: no] ]]></option> + <option><![CDATA[--auto=<no|yes> [default: yes] ]]></option> </term> <listitem> <para>When enabled, automatically annotates every file that diff --git a/cachegrind/tests/ann1.vgtest b/cachegrind/tests/ann1.vgtest index 81243d3..676fe31 100644 --- a/cachegrind/tests/ann1.vgtest +++ b/cachegrind/tests/ann1.vgtest @@ -2,5 +2,5 @@ # the post-processing of the cgout-test file. prog: ../../tests/true vgopts: --cachegrind-out-file=cachegrind.out -post: perl ../../cachegrind/cg_annotate --show=Ir,I1mr,ILmr --auto=yes cgout-test +post: perl ../../cachegrind/cg_annotate --show=Ir,I1mr,ILmr --show-percs=no cgout-test cleanup: rm cachegrind.out diff --git a/cachegrind/tests/ann2.vgtest b/cachegrind/tests/ann2.vgtest index b46da02..5acc68b 100644 --- a/cachegrind/tests/ann2.vgtest +++ b/cachegrind/tests/ann2.vgtest @@ -2,5 +2,5 @@ # the post-processing of the cgout-test file. prog: ../../tests/true vgopts: --cachegrind-out-file=cachegrind.out -post: perl ../../cachegrind/cg_annotate --sort=Dr --show=Dw,Dr,Ir --auto=yes --show-percs=yes cgout-test +post: perl ../../cachegrind/cg_annotate --sort=Dr --show=Dw,Dr,Ir --auto=yes cgout-test cleanup: rm cachegrind.out diff --git a/callgrind/callgrind_annotate.in b/callgrind/callgrind_annotate.in index 8854aee..16c0edf 100644 --- a/callgrind/callgrind_annotate.in +++ b/callgrind/callgrind_annotate.in @@ -139,11 +139,11 @@ my $default_threshold = 99; my $single_threshold = $default_threshold; # If on, show a percentage for each non-zero count. -my $show_percs = 0; +my $show_percs = 1; # If on, automatically annotates all files that are involved in getting over # all the threshold counts. -my $auto_annotate = 0; +my $auto_annotate = 1; # Number of lines to show around each annotated line. my $context = 8; @@ -211,9 +211,9 @@ usage: callgrind_annotate [options] [callgrind-out-file [source-files...]] Each event can optionally be followed by a : and a threshold percentage. If some event specific threshold are given, --threshold value is ignored. - --show-percs=yes|no show a percentage for each non-zero count + --show-percs=yes|no show a percentage for each non-zero count [yes] --auto=yes|no annotate all source files containing functions - that helped reach the event count threshold [no] + that helped reach the event count threshold [yes] --context=N print N lines of context before and after annotated lines [8] --inclusive=yes|no add subroutine costs to functions calls [no] diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 38dc73d..713c1b7 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -156,7 +156,7 @@ has to rely on heuristics to detect calls and returns.</para> </listitem> </itemizedlist> - <para>Use <option>--auto=yes</option> to get annotated source code + <para>By default, you will also get annotated source code for all relevant functions for which the source can be found. In addition to source annotation as produced by <computeroutput>cg_annotate</computeroutput>, you will see the @@ -1307,7 +1307,7 @@ their arguments.</para> <varlistentry> <term> - <option><![CDATA[--auto=<yes|no> [default: no] ]]></option> + <option><![CDATA[--auto=<yes|no> [default: yes] ]]></option> </term> <listitem> <para>Annotate all source files containing functions that helped diff --git a/callgrind/tests/ann1.vgtest b/callgrind/tests/ann1.vgtest index 6b80ee3..4ad9ae3 100644 --- a/callgrind/tests/ann1.vgtest +++ b/callgrind/tests/ann1.vgtest @@ -2,5 +2,5 @@ # the post-processing of the cgout-test file. prog: ../../tests/true vgopts: --callgrind-out-file=callgrind.out -post: perl ../../callgrind/callgrind_annotate --show=Ir,I1mr,ILmr --auto=yes --include=../../cachegrind/tests ../../cachegrind/tests/cgout-test +post: perl ../../callgrind/callgrind_annotate --show=Ir,I1mr,ILmr --show-percs=no --include=../../cachegrind/tests ../../cachegrind/tests/cgout-test cleanup: rm callgrind.out diff --git a/callgrind/tests/ann2.vgtest b/callgrind/tests/ann2.vgtest index e92f93a..30e1779 100644 --- a/callgrind/tests/ann2.vgtest +++ b/callgrind/tests/ann2.vgtest @@ -2,5 +2,5 @@ # the post-processing of the cgout-test file. prog: ../../tests/true vgopts: --callgrind-out-file=callgrind.out -post: perl ../../callgrind/callgrind_annotate --sort=Dr --show=Dw,Dr,Ir --auto=yes --include=../../cachegrind/tests --show-percs=yes ../../cachegrind/tests/cgout-test +post: perl ../../callgrind/callgrind_annotate --sort=Dr --show=Dw,Dr,Ir --auto=yes --include=../../cachegrind/tests ../../cachegrind/tests/cgout-test cleanup: rm callgrind.out |
