blob: 52bdc0ea7936af20386a362d41d637c99dd60dcc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>LuaCov Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>LuaCov</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Tables">Tables</a></li>
<li><a href="#Fields">Fields</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/luacov.html">luacov</a></li>
<li><strong>luacov.defaults</strong></li>
<li><a href="../modules/luacov.reporter.html">luacov.reporter</a></li>
<li><a href="../modules/luacov.runner.html">luacov.runner</a></li>
<li><a href="../modules/luacov.stats.html">luacov.stats</a></li>
<li><a href="../modules/luacov.tick.html">luacov.tick</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>luacov.defaults</code></h1>
<p>Default configuration file.</p>
<p> Copy, customize and store in your
project folder as '.luacov' for project specific configuration.
If some options are missing, their default values from this file
will be used.</p>
<h2><a href="#Tables">Tables</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#include">include</a></td>
<td class="summary">Lua patterns for files to include when reporting.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#exclude">exclude</a></td>
<td class="summary">Lua patterns for files to exclude when reporting.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#modules">modules</a></td>
<td class="summary">Table mapping names of modules to be included to their filenames.</td>
</tr>
</table>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#statsfile">statsfile</a></td>
<td class="summary">Filename to store collected stats.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#reportfile">reportfile</a></td>
<td class="summary">Filename to store report.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#savestepsize">savestepsize</a></td>
<td class="summary">Stats file updating frequency for <a href="../modules/luacov.tick.html#">luacov.tick</a>.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#runreport">runreport</a></td>
<td class="summary">Run reporter on completion?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#deletestats">deletestats</a></td>
<td class="summary">Delete stats file after reporting?</td>
</tr>
<tr>
<td class="name" nowrap><a href="#codefromstrings">codefromstrings</a></td>
<td class="summary">Process Lua code loaded from raw strings?</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Tables"></a>Tables</h2>
<dl class="function">
<dt>
<a name = "include"></a>
<strong>include</strong>
</dt>
<dd>
Lua patterns for files to include when reporting.
All will be included if nothing is listed.
Do not include the '.lua' extension. Path separator is always '/'.
Overruled by <a href="../modules/luacov.defaults.html#exclude">exclude</a>.
</dd>
<dt>
<a name = "exclude"></a>
<strong>exclude</strong>
</dt>
<dd>
Lua patterns for files to exclude when reporting.
Nothing will be excluded if nothing is listed.
Do not include the '.lua' extension. Path separator is always '/'.
Overrules <a href="../modules/luacov.defaults.html#include">include</a>.
</dd>
<dt>
<a name = "modules"></a>
<strong>modules</strong>
</dt>
<dd>
Table mapping names of modules to be included to their filenames.
Has no effect if empty.
Real filenames mentioned here will be used for reporting
even if the modules have been installed elsewhere.
Module name can contain '*' wildcard to match groups of modules,
in this case corresponding path will be used as a prefix directory
where modules from the group are located.
<h3>Usage:</h3>
<ul>
<pre class="example">
modules = {
[<span class="string">"some_rock"</span>] = <span class="string">"src/some_rock.lua"</span>,
[<span class="string">"some_rock.*"</span>] = <span class="string">"src"</span>
}</pre>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
<dl class="function">
<dt>
<a name = "statsfile"></a>
<strong>statsfile</strong>
</dt>
<dd>
Filename to store collected stats. Default: "luacov.stats.out".
</dd>
<dt>
<a name = "reportfile"></a>
<strong>reportfile</strong>
</dt>
<dd>
Filename to store report. Default: "luacov.report.out".
</dd>
<dt>
<a name = "savestepsize"></a>
<strong>savestepsize</strong>
</dt>
<dd>
Stats file updating frequency for <a href="../modules/luacov.tick.html#">luacov.tick</a>.
The lower this value - the more frequently results will be written out to the stats file.
You may want to reduce this value (to, for example, 2) to avoid losing coverage data in
case your program may terminate without triggering luacov exit hooks that are supposed
to save the data. Default: 100.
</dd>
<dt>
<a name = "runreport"></a>
<strong>runreport</strong>
</dt>
<dd>
Run reporter on completion? Default: false.
</dd>
<dt>
<a name = "deletestats"></a>
<strong>deletestats</strong>
</dt>
<dd>
Delete stats file after reporting? Default: false.
</dd>
<dt>
<a name = "codefromstrings"></a>
<strong>codefromstrings</strong>
</dt>
<dd>
Process Lua code loaded from raw strings?
That is, when the 'source' field in the debug info
does not start with '@'. Default: false.
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
<i style="float:right;">Last updated 2016-04-18 11:50:47 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
