diff --git a/cachegrind/docs/manual.html b/cachegrind/docs/manual.html index 2379a1966..5c57e71f8 100644 --- a/cachegrind/docs/manual.html +++ b/cachegrind/docs/manual.html @@ -93,7 +93,7 @@ The two steps are:
--auto=yes option. You can annotate C/C++
@@ -225,7 +225,7 @@ Combined instruction and data figures for the L2 cache follow that.
As well as printing summary information, Cachegrind also writes
line-by-line cache profiling information to a file named
cachegrind.out.pid. This file is human-readable, but is
-best interpreted by the accompanying program vg_annotate,
+best interpreted by the accompanying program cg_annotate,
described in the next section.
Things to note about the cachegrind.out.pid file:
@@ -277,14 +277,14 @@ The interesting cache-simulation specific options are:
vg_annotate, it is worth widening your
+Before using cg_annotate, it is worth widening your
window to be at least 120-characters wide if possible, as the output
lines can be quite long.
-To get a function-by-function summary, run
The output looks like this:
@@ -370,9 +370,9 @@ First up is a summary of the annotation options:
shown" line (and can be changed with the vg_annotate
+To get a function-by-function summary, run cg_annotate
--pid in a directory containing a
cachegrind.out.pid file. The --pid
-is required so that vg_annotate knows which log file to use when
+is required so that cg_annotate knows which log file to use when
several are present.
--show option).
-
vg_annotate by default omits functions
+ cg_annotate by default omits functions
that cause very low numbers of misses to avoid drowning you in
- information. In this case, vg_annotate shows summaries the
+ information. In this case, cg_annotate shows summaries the
functions that account for 99% of the Ir counts;
Ir is chosen as the threshold event since it is the
primary sort event. The threshold can be adjusted with the
@@ -415,8 +415,8 @@ It is worth noting that functions will come from three types of source files:
There are two ways to annotate source files -- by choosing them
manually, or with the --auto=yes option. To do it
manually, just specify the filenames as arguments to
-vg_annotate. For example, the output from running
-vg_annotate concord.c for our example produces the same
+cg_annotate. For example, the output from running
+cg_annotate concord.c for our example produces the same
output as above followed by an annotated version of
concord.c, a section of which looks like:
@@ -481,8 +481,8 @@ you know which part of a file the shown code comes from, eg:
The amount of context to show around annotated lines is controlled by the
--context option.
-To get automatic annotation, run vg_annotate --auto=yes.
-vg_annotate will automatically annotate every source file it can find that is
+To get automatic annotation, run cg_annotate --auto=yes.
+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 the --sort and
--threshold options. Each source file is clearly marked
@@ -507,7 +507,7 @@ Use the -I/--include option to tell Valgrind where to look for
source files if the filenames found from the debugging information aren't
specific enough.
-Beware that vg_annotate can take some time to digest large
+Beware that cg_annotate can take some time to digest large
cachegrind.out.pid files, e.g. 30 seconds or more. Also
beware that auto-annotation can produce a lot of output if your program is
large!
@@ -531,7 +531,7 @@ You can then profile and annotate source files in the same way as for C/C++
programs.
-
vg_annotate optionscg_annotate options--pid@@ -590,7 +590,7 @@ programs.
The number of counts in each line and the
summary_line should not exceed the number of events in the
event_line. If the number in each line is less,
-vg_annotate treats those missing as though they were a "." entry.
+cg_annotate treats those missing as though they were a "." entry.
A file_line changes the current file name. A fn_line
changes the current function name. A count_line contains counts
@@ -437,7 +437,7 @@ This is a summary of the important features:
-In particular, vg_annotate would not need to change -- the file format is such
+In particular, cg_annotate would not need to change -- the file format is such
that it is not specific to the cache simulation, but could be used for any kind
-of line-by-line information. The only part of vg_annotate that is specific to
+of line-by-line information. The only part of cg_annotate that is specific to
the cache simulation is the name of the input file
(cachegrind.out), although it would be very simple to add an
option to control this.