|
From: Dirk M. <mu...@kd...> - 2005-07-27 12:52:24
|
SVN commit 439218 by mueller: sync README with 3.0 M +19 -18 README =20 --- trunk/valgrind/README #439217:439218 @@ -14,15 +14,15 @@ =20 Executive Summary ~~~~~~~~~~~~~~~~~ -Valgrind is a GPL'd system for debugging and profiling x86-Linux program= s. -With the tools that come with Valgrind, you can automatically detect -many memory management and threading bugs, avoiding hours of frustrating -bug-hunting, making your programs more stable. You can also perform -detailed profiling to help speed up your programs. +Valgrind is an award-winning suite of tools for debugging and profiling +Linux programs. With the tools that come with Valgrind, you can +automatically detect many memory management and threading bugs, avoiding +hours of frustrating bug-hunting, making your programs more stable. You = can +also perform detailed profiling, to speed up and reduce memory use of yo= ur +programs. =20 -The Valgrind distribution includes five tools: two memory error +The Valgrind distribution currently includes five tools: two memory erro= r detectors, a thread error detector, a cache profiler and a heap profiler= . -Several other tools have been built with Valgrind. =20 To give you an idea of what Valgrind tools do, when a program is run under the supervision of the first memory error detector tool, all reads @@ -63,31 +63,32 @@ =20 Building and installing it ~~~~~~~~~~~~~~~~~~~~~~~~~~ -To install from CVS : +To install from the Subversion repository : =20 - 0. Check out the code from CVS, following the instructions at - http://developer.kde.org/source/anoncvs.html. The 'modulename' is - "valgrind". + 0. Check out the code from SVN, following the instructions at + http://valgrind.org/devel/cvs_svn.html. =20 1. cd into the source directory. =20 2. Run ./autogen.sh to setup the environment (you need the standard autoconf tools to do so). =20 + 3. Continue with the following instructions... + To install from a tar.bz2 distribution: =20 - 3. Run ./configure, with some options if you wish. The standard + 4. Run ./configure, with some options if you wish. The standard options are documented in the INSTALL file. The only interesting one is the usual --prefix=3D/where/you/want/it/installed. =20 - 4. Do "make". + 5. Do "make". =20 - 5. Do "make install", possibly as root if the destination permissions + 6. Do "make install", possibly as root if the destination permissions require that. =20 - 6. See if it works. Try "valgrind --tool=3Dmemcheck ls -l". Either - this works, or it bombs out with some complaint. In that case, - please let us know (see www.valgrind.org). + 7. See if it works. Try "valgrind ls -l". Either this works, or it + bombs out with some complaint. In that case, please let us know + (see www.valgrind.org). =20 Important! Do not move the valgrind installation into a place different from that specified by --prefix at build time. This will @@ -96,5 +97,5 @@ =20 =20 Julian Seward (js...@ac...) -Nick Nethercote (nj...@ca...) +Nick Nethercote (nj...@va...) Jeremy Fitzhardinge (je...@go...) |