Fix memory leak in launcher-linux.c
[valgrind.git] / README
blob0d3ac1de47ffae58966549167c4c18d0cd3c1f08
2 Release notes for Valgrind
3 ~~~~~~~~~~~~~~~~~~~~~~~~~~
4 If you are building a binary package of Valgrind for distribution,
5 please read README_PACKAGERS.  It contains some important information.
7 If you are developing Valgrind, please read README_DEVELOPERS.  It contains
8 some useful information.
10 For instructions on how to build/install, see the end of this file.
12 If you have problems, consult the FAQ to see if there are workarounds.
15 Executive Summary
16 ~~~~~~~~~~~~~~~~~
17 Valgrind is a framework for building dynamic analysis tools. There are
18 Valgrind tools that can automatically detect many memory management
19 and threading bugs, and profile your programs in detail. You can also
20 use Valgrind to build new tools.
22 The Valgrind distribution currently includes six production-quality
23 tools: a memory error detector, two thread error detectors, a cache
24 and branch-prediction profiler, a call-graph generating cache abd
25 branch-prediction profiler, and a heap profiler. It also includes
26 three experimental tools: a heap/stack/global array overrun detector,
27 a different kind of heap profiler, and a SimPoint basic block vector
28 generator.
30 Valgrind is closely tied to details of the CPU, operating system and to
31 a lesser extent, compiler and basic C libraries. This makes it difficult
32 to make it portable.  Nonetheless, it is available for the following
33 platforms: 
35 - X86/Linux
36 - AMD64/Linux
37 - PPC32/Linux
38 - PPC64/Linux
39 - ARM/Linux
40 - ARM64/Linux
41 - x86/macOS
42 - AMD64/macOS
43 - S390X/Linux
44 - MIPS32/Linux
45 - MIPS64/Linux
46 - X86/Solaris
47 - AMD64/Solaris
49 Note that AMD64 is just another name for x86_64, and Valgrind runs fine
50 on Intel processors.  Also note that the core of macOS is called
51 "Darwin" and this name is used sometimes.
53 Valgrind is licensed under the GNU General Public License, version 2. 
54 Read the file COPYING in the source distribution for details.
56 However: if you contribute code, you need to make it available as GPL
57 version 2 or later, and not 2-only.
60 Documentation
61 ~~~~~~~~~~~~~
62 A comprehensive user guide is supplied.  Point your browser at
63 $PREFIX/share/doc/valgrind/manual.html, where $PREFIX is whatever you
64 specified with --prefix= when building.
67 Building and installing it
68 ~~~~~~~~~~~~~~~~~~~~~~~~~~
69 To install from the GIT repository:
71   0. Clone the code from GIT:
72      git clone git://sourceware.org/git/valgrind.git
73      There are further instructions at
74      http://www.valgrind.org/downloads/repository.html.
76   1. cd into the source directory.
78   2. Run ./autogen.sh to setup the environment (you need the standard
79      autoconf tools to do so).
81   3. Continue with the following instructions...
83 To install from a tar.bz2 distribution:
85   4. Run ./configure, with some options if you wish.  The only interesting
86      one is the usual --prefix=/where/you/want/it/installed.
88   5. Run "make".
90   6. Run "make install", possibly as root if the destination permissions
91      require that.
93   7. See if it works.  Try "valgrind ls -l".  Either this works, or it
94      bombs out with some complaint.  In that case, please let us know
95      (see http://valgrind.org/support/bug_reports.html).
97 Important!  Do not move the valgrind installation into a place
98 different from that specified by --prefix at build time.  This will
99 cause things to break in subtle ways, mostly when Valgrind handles
100 fork/exec calls.
103 The Valgrind Developers