Started overhauling the documentation:

- There were detailed descriptions of all the tools in the Quick Start
  Guide, the Manual introduction, and the start of each tool chapter.  To
  avoid duplication/overlap, I removed these altogether from the Quick Start
  Guide, and shortened them in the intro.

- Improved the description of what errors Memcheck can find.

- Made all tool chapters start with "Overview" section, for consistency.

- Made the "run with --tool=XXX" bit consistent in each tool chapter.

- Made all tool chapter titles match the description given when running them.

- Added BBV to the User Manual intro.

- Generally clarified, updated, and future-proofed various bits of text in
  the Quick Start Guide and User Manual introduction. 

Also:
- Changed Nulgrind's start-up description to "the minimal Valgrind tool".

- Fixed some punctuation in the usage message.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10652 a5019735-40e9-0310-863c-91ae7b9d1cf9

1 files changed, 7 insertions, 7 deletions

diff --git a/exp-bbv/docs/bbv-manual.xml b/exp-bbv/docs/bbv-manual.xml
index a699a5f5..25d7a467 100644
--- a/exp-bbv/docs/bbv-manual.xml
+++ b/exp-bbv/docs/bbv-manual.xml
@@ -3,14 +3,14 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <chapter id="bbv-manual" xreflabel="BBV">
-  <title>BBV: a Basic Block Vector generation tool</title>
+  <title>BBV: an experimental basic block vector generation tool</title>
 
 <para>To use this tool, you must specify
 <computeroutput>--tool=exp-bbv</computeroutput> on the Valgrind
 command line.</para>
 
-<sect1 id="bbv-manual.background" xreflabel="BBV Background">
-<title>Basic Block Profiling and SimPoint</title>
+<sect1 id="bbv-manual.overview" xreflabel="Overview">
+<title>Overview</title>
 
 <para>
    A Basic Blocks Vector (BBV) is a list of all basic blocks entered
@@ -20,7 +20,7 @@ command line.</para>
 </para>
 
 <para>
-   This tool was written to generate basic block vectors
+   BBV is tool that generates basic block vectors
    for use with the SimPoint analysis tool 
    (http://www.cse.ucsd.edu/~calder/simpoint/).
    The SimPoint methodology enables speeding up architectural 
@@ -39,14 +39,14 @@ command line.</para>
   In computer architecture research, running a 
   benchmark on a cycle-accurate simulator can cause slowdowns on the order
   of 1000 times, making it take days, weeks, or even longer to run full
-  benchmarks.  By utilizing SimPoint this can be reduced significantly
-  while still retaining reasonable accuracy, usually in the 5-10% range.
+  benchmarks.  By utilizing SimPoint this can be reduced significantly,
+  usually by 90-95%, while still retaining reasonable accuracy.
 </para>
 
 <para>
    A more complete introduction to how SimPoint works can be 
    found in the paper "Automatically Characterizing Large Scale 
-   Program Behavior" by T. Sherwood, E Perelman, G. Hamerly, and 
+   Program Behavior" by T. Sherwood, E. Perelman, G. Hamerly, and 
    B. Calder.  
 </para>