development/Win32/vld/vld.ini

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