aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authortilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2007-11-01 17:17:56 +0000
committertilghman <tilghman@f38db490-d61c-443f-a65b-d21fe96a405b>2007-11-01 17:17:56 +0000
commitbf45a8b4ccb836b0a42ac281c7082992dc863826 (patch)
tree61d1a2883846d2afa7bf430b5f61d954525e8141 /doc
parent6fa32a6397c022b71be83f08e4b12f526d75cfb2 (diff)
Add some notes on using valgrind
git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@88116 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
-rw-r--r--doc/valgrind.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/valgrind.txt b/doc/valgrind.txt
new file mode 100644
index 000000000..067e29618
--- /dev/null
+++ b/doc/valgrind.txt
@@ -0,0 +1,19 @@
+If you're having certain types of crashes, such as those associated with
+memory corruption, a bug marshal may ask you to run Asterisk under valgrind.
+You should follow these steps, to give the bug marshal the maximum amount
+of information about the crash.
+
+1. Run 'make menuselect' and in the Compiler Options, enable MALLOC_DEBUG
+ and DONT_OPTIMIZE. A bug marshal may also ask you to enable additional
+ compiler flags, such as DEBUG_THREADS, depending upon the nature of the
+ issue.
+
+2. Rebuild and install Asterisk.
+
+3. Run Asterisk as follows:
+ valgrind --log-file-exact=valgrind.txt asterisk -vvvvcg 2>malloc_debug.txt
+
+4. Reproduce the issue. Following the manifestation of the issue (or when
+ the process crashes), upload the two files, valgrind.txt and
+ malloc_debug.txt to the issue tracker.
+