development/Win32/vld/vld.ini

   1 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
   2 ;;  $Id: vld.ini,v 1.7 2006/11/18 03:12:35 dmouldin Exp $
   3 ;;
   4 ;;  Visual Leak Detector - Initialization/Configuration File
   5 ;;  Copyright (c) 2006 Dan Moulding
   6 ;;
   7 ;;  This library is free software; you can redistribute it and/or
   8 ;;  modify it under the terms of the GNU Lesser General Public
   9 ;;  License as published by the Free Software Foundation; either
  10 ;;  version 2.1 of the License, or (at your option) any later version.
  11 ;;
  12 ;;  This library is distributed in the hope that it will be useful,
  13 ;;  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;;  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 ;;  Lesser General Public License for more details.
  16 ;;
  17 ;;  You should have received a copy of the GNU Lesser General Public
  18 ;;  License along with this library; if not, write to the Free Software
  19 ;;  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20 ;;
  21 ;;  See COPYING.txt for the full terms of the GNU Lesser General Public License.
  22 ;;
  23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  24
  25 ; Any options left blank or not present will revert to their default values.
  26 [Options]
  27
  28 ; The main on/off switch. If off, Visual Leak Detector will be completely
  29 ; disabled. It will do nothing but print a message to the debugger indicating
  30 ; that it has been turned off.
  31 ;
  32 ;  Valid Values: on, off
  33 ;  Default: on
  34 ;
  35 VLD = on
  36
  37 ; If yes, duplicate leaks (those that are identical) are not shown individually.
  38 ; Only the first such leak is shown, along with a number indicating the total
  39 ; number of duplicate leaks.
  40 ;
  41 ;   Valid Values: yes, no
  42 ;   Default: no
  43 ;
  44 AggregateDuplicates = no
  45
  46 ; Lists any additional modules to be included in memory leak detection. This can
  47 ; be useful for checking for memory leaks in debug builds of 3rd party modules
  48 ; which can not be easily rebuilt with '#include "vld.h"'. This option should be
  49 ; used only if absolutely necessary and only if you really know what you are
  50 ; doing.
  51 ;
  52 ;   CAUTION: Avoid listing any modules that link with the release CRT libraries.
  53 ;     Only modules that link with the debug CRT libraries should be listed here.
  54 ;     Doing otherwise might result in false memory leak reports or even crashes.
  55 ;
  56 ;   Valid Values: Any list containing module names (i.e. names of EXEs or DLLs).
  57 ;   Default: None.
  58 ;
  59 ; Also track Qt's allocations: (not 100% sure that the reported leaks are correct)
  60 ;ForceIncludeModules = QtCored4.dll QtGuid4.dll
  61 ForceIncludeModules =
  62
  63 ; Maximum number of data bytes to display for each leaked block. If zero, then
  64 ; the data dump is completely suppressed and only call stacks are shown.
  65 ; Limiting this to a low number can be useful if any of the leaked blocks are
  66 ; very large and cause unnecessary clutter in the memory leak report.
  67 ;
  68 ;   Value Values: 0 - 4294967295
  69 ;   Default: 4294967295
  70 ;
  71 MaxDataDump =
  72
  73 ; Maximum number of call stack frames to trace back during leak detection.
  74 ; Limiting this to a low number can reduce the CPU utilization overhead imposed
  75 ; by memory leak detection, especially when using the slower "safe" stack
  76 ; walking method (see StackWalkMethod below).
  77 ;
  78 ;   Valid Values: 1 - 4294967295
  79 ;   Default: 4294967295
  80 ;
  81 MaxTraceFrames =
  82
  83 ; Sets the type of encoding to use for the generated memory leak report. This
  84 ; option is really only useful in conjuction with sending the report to a file.
  85 ; Sending a Unicode encoded report to the debugger is not useful because the
  86 ; debugger cannot display Unicode characters. Using Unicode encoding might be
  87 ; useful if the data contained in leaked blocks is likely to consist of Unicode
  88 ; text.
  89 ;
  90 ;   Valid Values: ascii, unicode
  91 ;   Default: ascii
  92 ;
  93 ReportEncoding = ascii
  94
  95 ; Sets the report file destination, if reporting to file is enabled. A relative
  96 ; path may be specified and is considered relative to the process' working
  97 ; directory.
  98 ;
  99 ;   Valid Values: Any valid path and filename.
 100 ;   Default: .\memory_leak_report.txt
 101 ;
 102 ReportFile =
 103
 104 ; Sets the report destination to either a file, the debugger, or both. If
 105 ; reporting to file is enabled, the report is sent to the file specified by the
 106 ; ReportFile option.
 107 ;
 108 ;   Valid Values: debugger, file, both
 109 ;   Default: debugger
 110 ;
 111 ReportTo = debugger
 112
 113 ; Turns on or off a self-test mode which is used to verify that VLD is able to
 114 ; detect memory leaks in itself. Intended to be used for debugging VLD itself,
 115 ; not for debugging other programs.
 116 ;
 117 ;   Valid Values: on, off
 118 ;   Default: off
 119 ;
 120 SelfTest = off
 121
 122 ; Selects the method to be used for walking the stack to obtain stack traces for
 123 ; allocated memory blocks. The "fast" method may not always be able to
 124 ; successfully trace completely through all call stacks. In such cases, the
 125 ; "safe" method may prove to more reliably obtain the full stack trace. The
 126 ; disadvantage is that the "safe" method is significantly slower than the "fast"
 127 ; method and will probably result in very noticeable performance degradation of
 128 ; the program being debugged.
 129 ;
 130 ;   Valid Values: fast, safe
 131 ;   Default: fast
 132 ;
 133 StackWalkMethod = fast
 134
 135 ; Determines whether memory leak detection should be initially enabled for all
 136 ; threads, or whether it should be initially disabled for all threads. If set
 137 ; to "yes", then any threads requiring memory leak detection to be enabled will
 138 ; need to call VLDEnable at some point to enable leak detection for those
 139 ; threads.
 140 ;
 141 ;   Valid Values: yes, no
 142 ;   Default: no
 143 ;
 144 StartDisabled = no
 145
 146 ; Determines whether or not all frames, including frames internal to the heap,
 147 ; are traced. There will always be a number of frames internal to Visual Leak
 148 ; Detector and C/C++ or Win32 heap APIs that aren't generally useful for
 149 ; determining the cause of a leak. Normally these frames are skipped during the
 150 ; stack trace, which somewhat reduces the time spent tracing and amount of data
 151 ; collected and stored in memory. Including all frames in the stack trace, all
 152 ; the way down into VLD's own code can, however, be useful for debugging VLD
 153 ; itself.
 154 ;
 155 ;   Valid Values: yes, no
 156 ;   Default: no
 157 ;
 158 TraceInternalFrames = no