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 ForceIncludeModules =\r
  60 \r
  61 ; Maximum number of data bytes to display for each leaked block. If zero, then\r
  62 ; the data dump is completely suppressed and only call stacks are shown.\r
  63 ; Limiting this to a low number can be useful if any of the leaked blocks are\r
  64 ; very large and cause unnecessary clutter in the memory leak report.\r
  65 ;\r
  66 ;   Value Values: 0 - 4294967295\r
  67 ;   Default: 4294967295\r
  68 ;\r
  69 MaxDataDump = \r
  70 \r
  71 ; Maximum number of call stack frames to trace back during leak detection.\r
  72 ; Limiting this to a low number can reduce the CPU utilization overhead imposed\r
  73 ; by memory leak detection, especially when using the slower "safe" stack\r
  74 ; walking method (see StackWalkMethod below).\r
  75 ;\r
  76 ;   Valid Values: 1 - 4294967295\r
  77 ;   Default: 4294967295\r
  78 ;\r
  79 MaxTraceFrames = \r
  80 \r
  81 ; Sets the type of encoding to use for the generated memory leak report. This\r
  82 ; option is really only useful in conjuction with sending the report to a file.\r
  83 ; Sending a Unicode encoded report to the debugger is not useful because the\r
  84 ; debugger cannot display Unicode characters. Using Unicode encoding might be\r
  85 ; useful if the data contained in leaked blocks is likely to consist of Unicode\r
  86 ; text.\r
  87 ;\r
  88 ;   Valid Values: ascii, unicode\r
  89 ;   Default: ascii\r
  90 ;\r
  91 ReportEncoding = ascii\r
  92 \r
  93 ; Sets the report file destination, if reporting to file is enabled. A relative\r
  94 ; path may be specified and is considered relative to the process' working\r
  95 ; directory.\r
  96 ;\r
  97 ;   Valid Values: Any valid path and filename.\r
  98 ;   Default: .\memory_leak_report.txt\r
  99 ;\r
 100 ReportFile = \r
 101 \r
 102 ; Sets the report destination to either a file, the debugger, or both. If\r
 103 ; reporting to file is enabled, the report is sent to the file specified by the\r
 104 ; ReportFile option.\r
 105 ;\r
 106 ;   Valid Values: debugger, file, both\r
 107 ;   Default: debugger\r
 108 ;\r
 109 ReportTo = debugger\r
 110 \r
 111 ; Turns on or off a self-test mode which is used to verify that VLD is able to\r
 112 ; detect memory leaks in itself. Intended to be used for debugging VLD itself,\r
 113 ; not for debugging other programs.\r
 114 ;\r
 115 ;   Valid Values: on, off\r
 116 ;   Default: off\r
 117 ;\r
 118 SelfTest = off\r
 119 \r
 120 ; Selects the method to be used for walking the stack to obtain stack traces for\r
 121 ; allocated memory blocks. The "fast" method may not always be able to\r
 122 ; successfully trace completely through all call stacks. In such cases, the\r
 123 ; "safe" method may prove to more reliably obtain the full stack trace. The\r
 124 ; disadvantage is that the "safe" method is significantly slower than the "fast"\r
 125 ; method and will probably result in very noticeable performance degradation of\r
 126 ; the program being debugged.\r
 127 ;\r
 128 ;   Valid Values: fast, safe\r
 129 ;   Default: fast\r
 130 ; \r
 131 StackWalkMethod = fast\r
 132 \r
 133 ; Determines whether memory leak detection should be initially enabled for all\r
 134 ; threads, or whether it should be initially disabled for all threads. If set\r
 135 ; to "yes", then any threads requiring memory leak detection to be enabled will\r
 136 ; need to call VLDEnable at some point to enable leak detection for those\r
 137 ; threads.\r
 138 ;\r
 139 ;   Valid Values: yes, no\r
 140 ;   Default: no\r
 141 ;\r
 142 StartDisabled = no\r
 143 \r
 144 ; Determines whether or not all frames, including frames internal to the heap,\r
 145 ; are traced. There will always be a number of frames internal to Visual Leak\r
 146 ; Detector and C/C++ or Win32 heap APIs that aren't generally useful for\r
 147 ; determining the cause of a leak. Normally these frames are skipped during the\r
 148 ; stack trace, which somewhat reduces the time spent tracing and amount of data\r
 149 ; collected and stored in memory. Including all frames in the stack trace, all\r
 150 ; the way down into VLD's own code can, however, be useful for debugging VLD\r
 151 ; itself.\r
 152 ;\r
 153 ;   Valid Values: yes, no\r
 154 ;   Default: no\r
 155 ;\r
 156 TraceInternalFrames = no\r