aboutsummaryrefslogtreecommitdiff
path: root/cachegrind/docs/cg-manual.xml
diff options
context:
space:
mode:
authorsewardj <sewardj@a5019735-40e9-0310-863c-91ae7b9d1cf9>2007-11-22 01:21:56 +0000
committersewardj <sewardj@a5019735-40e9-0310-863c-91ae7b9d1cf9>2007-11-22 01:21:56 +0000
commit778d783077db6afb05cafcdc0471913d7b331b68 (patch)
tree3bdfe6954ea3403c81c5cc977b819f8677111e3c /cachegrind/docs/cg-manual.xml
parent14132a1d4f2c54232b4be8296375cca18625a6af (diff)
downloadvalgrind-778d783077db6afb05cafcdc0471913d7b331b68.tar.gz
Update documents in preparation for 3.3.0, and restructure them
somewhat to move less relevant material out of the way to some extent. The main changes are: * Update date and version info * Mention other tools in the quick-start guide * Document --child-silent-after-fork * Rearrange order of sections in the Valgrind Core chapter, to move advanced stuff (client requests) to the end, and compact stuff relevant to the majority of users towards the front * Move MPI debugging stuff from the Core manual (a nonsensical place for it) to the Memcheck chapter * Update the manual's introductory chapter a bit * Connect up new tech docs summary page, and disconnect old and very out of date valgrind/memcheck tech docs * Add section tags to the Cachegrind manual, to stop xsltproc complaining about their absence git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7199 a5019735-40e9-0310-863c-91ae7b9d1cf9
Diffstat (limited to 'cachegrind/docs/cg-manual.xml')
-rw-r--r--cachegrind/docs/cg-manual.xml19
1 files changed, 12 insertions, 7 deletions
diff --git a/cachegrind/docs/cg-manual.xml b/cachegrind/docs/cg-manual.xml
index 2a643ecc0..59b70e1d8 100644
--- a/cachegrind/docs/cg-manual.xml
+++ b/cachegrind/docs/cg-manual.xml
@@ -937,7 +937,7 @@ way as for C/C++ programs.</para>
-<sect2>
+<sect2 id="cg-manual.annopts.warnings" xreflabel="Warnings">
<title>Warnings</title>
<para>There are a couple of situations in which
@@ -969,7 +969,8 @@ warnings.</para>
-<sect2>
+<sect2 id="cg-manual.annopts.things-to-watch-out-for"
+ xreflabel="Things to watch out for">
<title>Things to watch out for</title>
<para>Some odd things that can occur during annotation:</para>
@@ -1084,7 +1085,7 @@ rare.</para>
-<sect2>
+<sect2 id="cg-manual.annopts.accuracy" xreflabel="Accuracy">
<title>Accuracy</title>
<para>Valgrind's cache profiling has a number of
@@ -1221,7 +1222,8 @@ fail these checks.</para>
</sect1>
-<sect1>
+<sect1 id="cg-manual.acting-on"
+ xreflabel="Acting on Cachegrind's information">
<title>Acting on Cachegrind's information</title>
<para>
So, you've managed to profile your program with Cachegrind. Now what?
@@ -1260,14 +1262,16 @@ yourself. But at least you have the information!
</sect1>
-<sect1>
+<sect1 id="cg-manual.impl-details"
+ xreflabel="Implementation details">
<title>Implementation details</title>
<para>
This section talks about details you don't need to know about in order to
use Cachegrind, but may be of interest to some people.
</para>
-<sect2>
+<sect2 id="cg-manual.impl-details.how-cg-works"
+ xreflabel="How Cachegrind works">
<title>How Cachegrind works</title>
<para>The best reference for understanding how Cachegrind works is chapter 3 of
"Dynamic Binary Analysis and Instrumentation", by Nicholas Nethercote. It
@@ -1275,7 +1279,8 @@ is available on the <ulink url="&vg-pubs;">Valgrind publications
page</ulink>.</para>
</sect2>
-<sect2>
+<sect2 id="cg-manual.impl-details.file-format"
+ xreflabel="Cachegrind output file format">
<title>Cachegrind output file format</title>
<para>The file format is fairly straightforward, basically giving the
cost centre for every line, grouped by files and