Finalise distro docs for 3.3.0.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@7287

diff --git a/ACKNOWLEDGEMENTS b/ACKNOWLEDGEMENTS
index 89926ce21905da228ff8beec980518908644fc03..65d1784c9d6a82b1408c8d2db71281b0d0459cb5 100644 (file)
--- a/ACKNOWLEDGEMENTS
+++ b/ACKNOWLEDGEMENTS
@@ -60,6 +60,9 @@ modified readelf's dwarf2 source line reader, written by Nick Clifton,
 for use in Valgrind.  Michael Matz and Simon Hausmann modified the GNU
 binutils demangler(s) for use in Valgrind.
 
+David Woodhouse and Tom Hughes have helped out with test and build
+machines over the course of many releases.
+
 Many, many people sent bug reports, patches, and helpful feedback.
 
 Development of Valgrind was supported in part by the Tri-Lab Partners

diff --git a/NEWS b/NEWS
index 31402ecab4d48e659ad55d345ad0c96d15622171..18565a1a522662a69e71fc0b4ae5de0ca83a505a 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -185,6 +185,7 @@ Omega and DRD.  There are many other smaller improvements.  In detail:
   146781  Adding support for private futexes
   147325  valgrind internal error on syscall (SYS_io_destroy, 0)
   147498  amd64->IR: 0xF0 0xF 0xB0 0xF (lock cmpxchg %cl,(%rdi))
+  147545  Memcheck: mc_main.c:817 (get_sec_vbits8): Assertion 'n' failed.
   147628  SALC opcode 0xd6 unimplemented
   147825  crash on amd64-linux with gcc 4.2 and glibc 2.6 (CFI)
   148174  Incorrect type of freed_list_volume causes assertion [...]

diff --git a/README b/README
index e8c1c5a6e156238eedb2b9d0d23420c4b1a2b685..3a75cd7eb1592d3ba12f306e2231cb8cb7cedde8 100644 (file)
--- a/README
+++ b/README
@@ -21,8 +21,11 @@ hours of frustrating bug-hunting, making your programs more stable. You can
 also perform detailed profiling, to speed up and reduce memory use of your
 programs.
 
-The Valgrind distribution currently includes four tools: a memory error
-detector, a thread error detector, a cache profiler and a heap profiler.
+The Valgrind distribution currently includes five production grade
+tools: a memory error detector, a thread error detector, a cache
+profiler, a call graph profiler and a heap profiler.  Experimental
+tools are also included.  They are distinguished by the "exp-" prefix
+on their names.
 
 To give you an idea of what Valgrind tools do, when a program is run
 under the supervision of Memcheck, the memory error detector tool, all

diff --git a/README_PACKAGERS b/README_PACKAGERS
index 5d0e9766000c2dd1499cc35648af9fb716201a4f..519d1472568824a807271728038ba7dc4d11cec2 100644 (file)
--- a/README_PACKAGERS
+++ b/README_PACKAGERS
@@ -1,9 +1,34 @@
 
+These notes were significantly updated on 6 Dec 2007 for the Valgrind
+3.3.0 release.
+
 Greetings, packaging person!  This information is aimed at people
 building binary distributions of Valgrind.
 
-Thanks for taking the time and effort to make a binary distribution
-of Valgrind.  The following notes may save you some trouble.
+Thanks for taking the time and effort to make a binary distribution of
+Valgrind.  The following notes may save you some trouble.
+
+
+-- Do not ship your Linux distro with a completely stripped
+   /lib/ld.so.  At least leave the debugging symbol names on -- line
+   number info isn't necessary.  If you don't want to leave symbols on
+   ld.so, alternatively you can have your distro install ld.so's
+   debuginfo package by default, or make ld.so.debuginfo be a
+   requirement of your Valgrind RPM/DEB/whatever.
+
+   Reason for this is that Valgrind's Memcheck tool needs to intercept
+   calls to, and provide replacements for, some symbols in ld.so at
+   startup (most importantly strlen).  If it cannot do that, Memcheck
+   shows a large number of false positives due to the highly optimised
+   strlen (etc) routines in ld.so.  This has caused some trouble in
+   the past.  As of version 3.3.0, on some targets (ppc32-linux,
+   ppc64-linux), Memcheck will simply stop at startup (and print an
+   error message) if such symbols are not present, because it is
+   infeasible to continue.
+
+   It's not like this is going to cost you much space.  We only need
+   the symbols for ld.so (a few K at most).  Not the debug info and
+   not any debuginfo or extra symbols for any other libraries.
 
 
 -- (Unfortunate but true) When you configure to build with the 
@@ -16,9 +41,10 @@ of Valgrind.  The following notes may save you some trouble.
    So you can't build a relocatable RPM / whatever from Valgrind.
 
 
--- Don't strip the debug info off stage2 or libpthread.so.
-   Valgrind will still work if you do, but it will generate less
-   helpful error messages.  Here's an example:
+-- Don't strip the debug info off lib/valgrind/$platform/vgpreload*.so
+   in the installation tree.  Either Valgrind won't work at all, or it
+   will still work if you do, but will generate less helpful error
+   messages.  Here's an example:
 
    Mismatched free() / delete / delete []
       at 0x40043249: free (vg_clientfuncs.c:171)
@@ -32,15 +58,15 @@ of Valgrind.  The following notes may save you some trouble.
       by 0x4C21788F: OLEFilter::convert(QCString const &) (olefilter.cc:272)
 
    This tells you that some memory allocated with new[] was freed with
-   free().  If stage2 was stripped the message would look like this:
+   free().
 
    Mismatched free() / delete / delete []
-      at 0x40043249: (inside stage2)
+      at 0x40043249: (inside vgpreload_memcheck.so)
       by 0x4102BB4E: QGArray::~QGArray(void) (tools/qgarray.cpp:149)
       by 0x4C261C41: PptDoc::~PptDoc(void) (include/qmemarray.h:60)
       by 0x4C261F0E: PptXml::~PptXml(void) (pptxml.cc:44)
       Address 0x4BB292A8 is 0 bytes inside a block of size 64 alloc'd
-      at 0x4004318C: (inside stage2)
+      at 0x4004318C: (inside vgpreload_memcheck.so)
       by 0x4C21BC15: KLaola::readSBStream(int) const (klaola.cc:314)
       by 0x4C21C155: KLaola::stream(KLaola::OLENode const *) (klaola.cc:416)
       by 0x4C21788F: OLEFilter::convert(QCString const &) (olefilter.cc:272)
@@ -51,15 +77,22 @@ of Valgrind.  The following notes may save you some trouble.
    from valgrind.
 
 
--- Please test the final installation works by running it on
-   something huge.  I suggest checking that it can start and
-   exit successfully both Mozilla-1.0 and OpenOffice.org 1.0.
-   I use these as test programs, and I know they fairly thoroughly
-   exercise Valgrind.  The command lines to use are:
+-- Don't strip symbols from lib/valgrind/$platform/{cachegrind,
+   callgrind,exp-drd,exp-omega,helgrind,lackey,massif,memcheck,none}
+   in the installation tree.  Doing so will likely cause problems.
+   Removing the line number info is probably OK, although that has not
+   been tested by the Valgrind developers.
+
+
+-- Please test the final installation works by running it on something
+   huge.  I suggest checking that it can start and exit successfully
+   both Firefox-2.0.0.X and OpenOffice.org 2.3.X.  I use these as test
+   programs, and I know they fairly thoroughly exercise Valgrind.  The
+   command lines to use are:
 
-   valgrind -v --trace-children=yes --workaround-gcc296-bugs=yes mozilla
+   valgrind -v --trace-children=yes mozilla
 
-   valgrind -v --trace-children=yes --workaround-gcc296-bugs=yes soffice
+   valgrind -v --trace-children=yes soffice
 
 
 If you find any more hints/tips for packaging, please report