Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/resource/bin/vld.ini.in @ 3534

Last change on this file since 3534 was 3196, checked in by rgrieder, 15 years ago

Merged pch branch back to trunk.

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