]> git.ipfire.org Git - thirdparty/valgrind.git/commitdiff
Very minor changes.
authorJulian Seward <jseward@acm.org>
Sun, 25 Nov 2007 00:56:51 +0000 (00:56 +0000)
committerJulian Seward <jseward@acm.org>
Sun, 25 Nov 2007 00:56:51 +0000 (00:56 +0000)
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7209

docs/README
docs/xml/index.xml
docs/xml/quick-start-guide.xml

index 81fea45098dda9c32b8c9b821d41e3e0207af04f..ef99feaf1d51e09feb21c3d1cee454f0ebfa5c7b 100644 (file)
@@ -148,6 +148,8 @@ to
   pool_size.pdfxmltex = 1500000
 and that fixes it.
 
+It is also reported that the print docs build OK on Fedora Core 5.
+
 
 Notes [Nov. 2005]
 -----------------
index 475e631b1aec6663fee3f82130dfa9929035d96b..758c669132d0ef12cc8748b9547fc4ee3e7f5c21 100644 (file)
     </copyright>
 
     <legalnotice>
-      <para>Permission is granted to copy, distribute and/or 
-      modify this document under the terms of the GNU Free Documentation License,
-      Version 1.2 or any later version published by the Free Software Foundation; 
-      with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-      Texts.  A copy of the license is included in the section entitled 
-      <xref linkend="license.gfdl"/>.</para>
+      <para>Permission is granted to copy, distribute and/or modify
+        this document under the terms of the GNU Free Documentation
+        License, Version 1.2 or any later version published by the
+        Free Software Foundation; with no Invariant Sections, with no
+        Front-Cover Texts, and with no Back-Cover Texts.  A copy of
+        the license is included in the section entitled
+        <xref linkend="license.gfdl"/>.
+      </para>
+      <para>This is the top level of Valgrind's documentation tree.
+        The documentation is contained in six logically separate
+        documents, as listed in the following Table of Contents.  To
+        get started quickly, read the Valgrind Quick Start Guide.  For
+        full documentation on Valgrind, read the Valgrind User Manual.
+      </para>
+
     </legalnotice>
 
   </setinfo>
index 773871bb7eb66494d29f93ad12b052b3af148a4e..d93f9d1ec6fd3f26c03dcbbacf547d0e649802b2 100644 (file)
@@ -54,16 +54,16 @@ Other tools you may find useful are:</para>
   <listitem>
     <para>Cachegrind: a profiling tool which produces detailed data on
     cache (miss) and branch (misprediction) events.  Statistics are
-    gathered for the entire program, for each function, for each line
-    of code, and even for each instruction, if you need that level of
-    detail.</para>
+    gathered for the entire program, for each function, and for each
+    line of code, if you need that level of detail.</para>
   </listitem>
   <listitem>
-    <para>Callgrind: a heavyweight profiling tool similar to
-    Cachegrind, but which also shows cost relationships across
-    function calls.  Information gathered by Callgrind can be viewed
-    using the KCachegrind GUI.  KCachegrind is not part of the
-    Valgrind suite - it is part of the KDE Desktop Environment.</para>
+    <para>Callgrind: a profiling tool that shows cost relationships
+    across function calls, optionally with cache simulation similar to
+    Cachegrind.  Information gathered by Callgrind can be viewed
+    either with an included command line tool, or by using the
+    KCachegrind GUI.  KCachegrind is not part of the Valgrind suite 
+    -- it is part of the KDE Desktop Environment.</para>
   </listitem>
   <listitem>
     <para>Massif: a space profiling tool.  It allows you to explore
@@ -84,8 +84,8 @@ Other tools you may find useful are:</para>
 </itemizedlist>
 
 <para>The rest of this guide discusses only the Memcheck tool.  For
-full documentation on the other tools, see the Valgrind User
-Manual.</para>
+full documentation on the other tools, and for Memcheck, see the
+Valgrind User Manual.</para>
 
 <para>What follows is the minimum information you need to start
 detecting memory errors in your program with Memcheck.  Note that this