OLD | NEW |
| (Empty) |
1 .TH lcovrc 5 "LCOV 1.9" 2010\-08\-06 "User Manuals" | |
2 | |
3 .SH NAME | |
4 lcovrc \- lcov configuration file | |
5 | |
6 .SH DESCRIPTION | |
7 The | |
8 .I lcovrc | |
9 file contains configuration information for the | |
10 .B lcov | |
11 code coverage tool (see | |
12 .BR lcov (1)). | |
13 .br | |
14 | |
15 The system\-wide configuration file is located at | |
16 .IR /etc/lcovrc . | |
17 To change settings for a single user, place a customized copy of this file at | |
18 location | |
19 .IR ~/.lcovrc . | |
20 Where available, command\-line options override configuration file settings. | |
21 | |
22 Lines in a configuration file can either be: | |
23 .IP " *" | |
24 empty lines or lines consisting only of white space characters. These lines are | |
25 ignored. | |
26 .IP " *" | |
27 comment lines which start with a hash sign ('#'). These are treated like empty | |
28 lines and will be ignored. | |
29 .IP " *" | |
30 statements in the form | |
31 .RI ' key " = " value '. | |
32 A list of valid statements and their description can be found in | |
33 section 'OPTIONS' below. | |
34 .PP | |
35 | |
36 .B Example configuration: | |
37 .IP | |
38 # | |
39 .br | |
40 # Example LCOV configuration file | |
41 .br | |
42 # | |
43 .br | |
44 | |
45 # External style sheet file | |
46 .br | |
47 #genhtml_css_file = gcov.css | |
48 .br | |
49 | |
50 # Coverage rate limits | |
51 .br | |
52 genhtml_hi_limit = 90 | |
53 .br | |
54 genhtml_med_limit = 75 | |
55 .br | |
56 | |
57 # Width of line coverage field in source code view | |
58 .br | |
59 genhtml_line_field_width = 12 | |
60 .br | |
61 | |
62 # Width of branch coverage field in source code view | |
63 .br | |
64 genhtml_branch_field_width = 16 | |
65 .br | |
66 | |
67 # Width of overview image | |
68 .br | |
69 genhtml_overview_width = 80 | |
70 .br | |
71 | |
72 # Resolution of overview navigation | |
73 .br | |
74 genhtml_nav_resolution = 4 | |
75 .br | |
76 | |
77 # Offset for source code navigation | |
78 .br | |
79 genhtml_nav_offset = 10 | |
80 .br | |
81 | |
82 # Do not remove unused test descriptions if non\-zero | |
83 .br | |
84 genhtml_keep_descriptions = 0 | |
85 .br | |
86 | |
87 # Do not remove prefix from directory names if non\-zero | |
88 .br | |
89 genhtml_no_prefix = 0 | |
90 .br | |
91 | |
92 # Do not create source code view if non\-zero | |
93 .br | |
94 genhtml_no_source = 0 | |
95 .br | |
96 | |
97 # Specify size of tabs | |
98 .br | |
99 genhtml_num_spaces = 8 | |
100 .br | |
101 | |
102 # Highlight lines with converted\-only data if non\-zero | |
103 .br | |
104 genhtml_highlight = 0 | |
105 .br | |
106 | |
107 # Include color legend in HTML output if non\-zero | |
108 .br | |
109 genhtml_legend = 0 | |
110 .br | |
111 | |
112 # Include HTML file at start of HTML output | |
113 .br | |
114 #genhtml_html_prolog = prolog.html | |
115 .br | |
116 | |
117 # Include HTML file at end of HTML output | |
118 .br | |
119 #genhtml_html_epilog = epilog.html | |
120 .br | |
121 | |
122 # Use custom HTML file extension | |
123 .br | |
124 #genhtml_html_extension = html | |
125 .br | |
126 | |
127 # Compress all generated html files with gzip. | |
128 .br | |
129 #genhtml_html_gzip = 1 | |
130 .br | |
131 | |
132 # Include sorted overview pages | |
133 .br | |
134 genhtml_sort = 1 | |
135 .br | |
136 | |
137 # Include function coverage data display | |
138 .br | |
139 genhtml_function_coverage = 1 | |
140 .br | |
141 | |
142 # Include branch coverage data display | |
143 .br | |
144 genhtml_branch_coverage = 1 | |
145 .br | |
146 | |
147 # Location of the gcov tool | |
148 .br | |
149 #geninfo_gcov_tool = gcov | |
150 .br | |
151 | |
152 # Adjust test names if non\-zero | |
153 .br | |
154 #geninfo_adjust_testname = 0 | |
155 .br | |
156 | |
157 # Calculate a checksum for each line if non\-zero | |
158 .br | |
159 geninfo_checksum = 0 | |
160 .br | |
161 | |
162 # Enable libtool compatibility mode if non\-zero | |
163 .br | |
164 geninfo_compat_libtool = 0 | |
165 .br | |
166 | |
167 # Directory containing gcov kernel files | |
168 .br | |
169 lcov_gcov_dir = /proc/gcov | |
170 .br | |
171 | |
172 # Location for temporary directories | |
173 .br | |
174 lcov_tmp_dir = /tmp | |
175 .br | |
176 | |
177 # Show full paths during list operation if non\-zero | |
178 .br | |
179 lcov_list_full_path = 0 | |
180 .br | |
181 | |
182 # Specify the maximum width for list output. This value is | |
183 .br | |
184 # ignored when lcov_list_full_path is non\-zero. | |
185 .br | |
186 lcov_list_width = 80 | |
187 .br | |
188 | |
189 # Specify the maximum percentage of file names which may be | |
190 .br | |
191 # truncated when choosing a directory prefix in list output. | |
192 .br | |
193 # This value is ignored when lcov_list_full_path is non\-zero. | |
194 .br | |
195 | |
196 lcov_list_truncate_max = 20 | |
197 .PP | |
198 | |
199 .SH OPTIONS | |
200 | |
201 .BR genhtml_css_file " =" | |
202 .I filename | |
203 .IP | |
204 Specify an external style sheet file. Use this option to modify the appearance o
f the HTML output as generated by | |
205 .BR genhtml . | |
206 During output generation, a copy of this file will be placed in the output | |
207 directory. | |
208 .br | |
209 | |
210 This option corresponds to the \-\-css\-file command line option of | |
211 .BR genhtml . | |
212 .br | |
213 | |
214 By default, a standard CSS file is generated. | |
215 .PP | |
216 | |
217 .BR genhtml_hi_limit " =" | |
218 .I hi_limit | |
219 .br | |
220 .BR genhtml_med_limit " =" | |
221 .I med_limit | |
222 .br | |
223 .IP | |
224 Specify coverage rate limits for classifying file entries. Use this option to | |
225 modify the coverage rates (in percent) for line, function and branch coverage at | |
226 which a result is classified as high, medium or low coverage. This | |
227 classification affects the color of the corresponding entries on the overview | |
228 pages of the HTML output: | |
229 .br | |
230 | |
231 High: hi_limit <= rate <= 100 default color: green | |
232 .br | |
233 Medium: med_limit <= rate < hi_limit default color: orange | |
234 .br | |
235 Low: 0 <= rate < med_limit default color: red | |
236 .br | |
237 | |
238 Defaults are 90 and 75 percent. | |
239 .PP | |
240 | |
241 .BR genhtml_line_field_width " =" | |
242 .I number_of_characters | |
243 .IP | |
244 Specify the width (in characters) of the source code view column containing | |
245 line coverage information. | |
246 .br | |
247 | |
248 Default is 12. | |
249 .PP | |
250 | |
251 .BR genhtml_branch_field_width " =" | |
252 .I number_of_characters | |
253 .IP | |
254 Specify the width (in characters) of the source code view column containing | |
255 branch coverage information. | |
256 .br | |
257 | |
258 Default is 16. | |
259 .PP | |
260 | |
261 .BR genhtml_overview_width " =" | |
262 .I pixel_size | |
263 .IP | |
264 Specify the width (in pixel) of the overview image created when generating HTML | |
265 output using the \-\-frames option of | |
266 .BR genhtml . | |
267 .br | |
268 | |
269 Default is 80. | |
270 .PP | |
271 | |
272 .BR genhtml_nav_resolution " =" | |
273 .I lines | |
274 .IP | |
275 Specify the resolution of overview navigation when generating HTML output using | |
276 the \-\-frames option of | |
277 .BR genhtml . | |
278 This number specifies the maximum difference in lines between the position a | |
279 user selected from the overview and the position the source code window is | |
280 scrolled to. | |
281 .br | |
282 | |
283 Default is 4. | |
284 .PP | |
285 | |
286 | |
287 .BR genhtml_nav_offset " =" | |
288 .I lines | |
289 .IP | |
290 Specify the overview navigation line offset as applied when generating HTML | |
291 output using the \-\-frames option of | |
292 .BR genhtml. | |
293 .br | |
294 | |
295 Clicking a line in the overview image should show the source code view at | |
296 a position a bit further up, so that the requested line is not the first | |
297 line in the window. This number specifies that offset. | |
298 .br | |
299 | |
300 Default is 10. | |
301 .PP | |
302 | |
303 | |
304 .BR genhtml_keep_descriptions " =" | |
305 .IR 0 | 1 | |
306 .IP | |
307 If non\-zero, keep unused test descriptions when generating HTML output using | |
308 .BR genhtml . | |
309 .br | |
310 | |
311 This option corresponds to the \-\-keep\-descriptions option of | |
312 .BR genhtml . | |
313 .br | |
314 | |
315 Default is 0. | |
316 .PP | |
317 | |
318 .BR genhtml_no_prefix " =" | |
319 .IR 0 | 1 | |
320 .IP | |
321 If non\-zero, do not try to find and remove a common prefix from directory names
. | |
322 .br | |
323 | |
324 This option corresponds to the \-\-no\-prefix option of | |
325 .BR genhtml . | |
326 .br | |
327 | |
328 Default is 0. | |
329 .PP | |
330 | |
331 .BR genhtml_no_source " =" | |
332 .IR 0 | 1 | |
333 .IP | |
334 If non\-zero, do not create a source code view when generating HTML output using | |
335 .BR genhtml . | |
336 .br | |
337 | |
338 This option corresponds to the \-\-no\-source option of | |
339 .BR genhtml . | |
340 .br | |
341 | |
342 Default is 0. | |
343 .PP | |
344 | |
345 .BR genhtml_num_spaces " =" | |
346 .I num | |
347 .IP | |
348 Specify the number of spaces to use as replacement for tab characters in the | |
349 HTML source code view as generated by | |
350 .BR genhtml . | |
351 .br | |
352 | |
353 This option corresponds to the \-\-num\-spaces option of | |
354 .BR genthml . | |
355 .br | |
356 | |
357 Default is 8. | |
358 | |
359 .PP | |
360 | |
361 .BR genhtml_highlight " =" | |
362 .IR 0 | 1 | |
363 .IP | |
364 If non\-zero, highlight lines with converted\-only data in | |
365 HTML output as generated by | |
366 .BR genhtml . | |
367 .br | |
368 | |
369 This option corresponds to the \-\-highlight option of | |
370 .BR genhtml . | |
371 .br | |
372 | |
373 Default is 0. | |
374 .PP | |
375 | |
376 .BR genhtml_legend " =" | |
377 .IR 0 | 1 | |
378 .IP | |
379 If non\-zero, include a legend explaining the meaning of color coding in the HTM
L | |
380 output as generated by | |
381 .BR genhtml . | |
382 .br | |
383 | |
384 This option corresponds to the \-\-legend option of | |
385 .BR genhtml . | |
386 .br | |
387 | |
388 Default is 0. | |
389 .PP | |
390 | |
391 .BR genhtml_html_prolog " =" | |
392 .I filename | |
393 .IP | |
394 If set, include the contents of the specified file at the beginning of HTML | |
395 output. | |
396 | |
397 This option corresponds to the \-\-html\-prolog option of | |
398 .BR genhtml . | |
399 .br | |
400 | |
401 Default is to use no extra prolog. | |
402 .PP | |
403 | |
404 .BR genhtml_html_epilog " =" | |
405 .I filename | |
406 .IP | |
407 If set, include the contents of the specified file at the end of HTML output. | |
408 | |
409 This option corresponds to the \-\-html\-epilog option of | |
410 .BR genhtml . | |
411 .br | |
412 | |
413 Default is to use no extra epilog. | |
414 .PP | |
415 | |
416 .BR genhtml_html_extension " =" | |
417 .I extension | |
418 .IP | |
419 If set, use the specified string as filename extension for generated HTML files. | |
420 | |
421 This option corresponds to the \-\-html\-extension option of | |
422 .BR genhtml . | |
423 .br | |
424 | |
425 Default extension is "html". | |
426 .PP | |
427 | |
428 .BR genhtml_html_gzip " =" | |
429 .IR 0 | 1 | |
430 .IP | |
431 If set, compress all html files using gzip. | |
432 | |
433 This option corresponds to the \-\-html\-gzip option of | |
434 .BR genhtml . | |
435 .br | |
436 | |
437 Default extension is 0. | |
438 .PP | |
439 | |
440 .BR genhtml_sort " =" | |
441 .IR 0 | 1 | |
442 .IP | |
443 If non\-zero, create overview pages sorted by coverage rates when generating | |
444 HTML output using | |
445 .BR genhtml . | |
446 .br | |
447 | |
448 This option can be set to 0 by using the \-\-no\-sort option of | |
449 .BR genhtml . | |
450 .br | |
451 | |
452 Default is 1. | |
453 .PP | |
454 | |
455 .BR genhtml_function_coverage " =" | |
456 .IR 0 | 1 | |
457 .IP | |
458 If non\-zero, include function coverage data when generating HTML output using | |
459 .BR genhtml . | |
460 .br | |
461 | |
462 This option can be set to 0 by using the \-\-no\-function\-coverage option of | |
463 .BR genhtml . | |
464 .br | |
465 | |
466 Default is 1. | |
467 .PP | |
468 | |
469 .BR genhtml_branch_coverage " =" | |
470 .IR 0 | 1 | |
471 .IP | |
472 If non\-zero, include branch coverage data when generating HTML output using | |
473 .BR genhtml . | |
474 .br | |
475 | |
476 This option can be set to 0 by using the \-\-no\-branch\-coverage option of | |
477 .BR genhtml . | |
478 .br | |
479 | |
480 Default is 1. | |
481 .PP | |
482 | |
483 .BR geninfo_gcov_tool " =" | |
484 .I path_to_gcov | |
485 .IP | |
486 Specify the location of the gcov tool (see | |
487 .BR gcov (1)) | |
488 which is used to generate coverage information from data files. | |
489 .br | |
490 | |
491 Default is 'gcov'. | |
492 .PP | |
493 | |
494 .BR geninfo_adjust_testname " =" | |
495 .IR 0 | 1 | |
496 .IP | |
497 If non\-zero, adjust test names to include operating system information | |
498 when capturing coverage data. | |
499 .br | |
500 | |
501 Default is 0. | |
502 .PP | |
503 | |
504 .BR geninfo_checksum " =" | |
505 .IR 0 | 1 | |
506 .IP | |
507 If non\-zero, generate source code checksums when capturing coverage data. | |
508 Checksums are useful to prevent merging coverage data from incompatible | |
509 source code versions but checksum generation increases the size of coverage | |
510 files and the time used to generate those files. | |
511 .br | |
512 | |
513 This option corresponds to the \-\-checksum and \-\-no\-checksum command line | |
514 option of | |
515 .BR geninfo . | |
516 .br | |
517 | |
518 Default is 0. | |
519 .PP | |
520 | |
521 .BR geninfo_compat_libtool " =" | |
522 .IR 0 | 1 | |
523 .IP | |
524 If non\-zero, enable libtool compatibility mode. When libtool compatibility | |
525 mode is enabled, lcov will assume that the source code relating to a .da file | |
526 located in a directory named ".libs" can be found in its parent directory. | |
527 .br | |
528 | |
529 This option corresponds to the \-\-compat\-libtool and \-\-no\-compat\-libtool | |
530 command line option of | |
531 .BR geninfo . | |
532 .br | |
533 | |
534 Default is 1. | |
535 .PP | |
536 | |
537 .BR lcov_gcov_dir " =" | |
538 .I path_to_kernel_coverage_data | |
539 .IP | |
540 Specify the path to the directory where kernel coverage data can be found | |
541 or leave undefined for auto-detection. | |
542 .br | |
543 | |
544 Default is auto-detection. | |
545 .PP | |
546 | |
547 .BR lcov_tmp_dir " =" | |
548 .I temp | |
549 .IP | |
550 Specify the location of a directory used for temporary files. | |
551 .br | |
552 | |
553 Default is '/tmp'. | |
554 .PP | |
555 | |
556 .BR lcov_list_full_path " =" | |
557 .IR 0 | 1 | |
558 .IP | |
559 If non-zero, print the full path to source code files during a list operation. | |
560 .br | |
561 | |
562 This option corresponds to the \-\-list\-full\-path option of | |
563 .BR lcov . | |
564 .br | |
565 | |
566 Default is 0. | |
567 .PP | |
568 | |
569 .BR lcov_list_max_width " =" | |
570 .IR width | |
571 .IP | |
572 Specify the maximum width for list output. This value is ignored when | |
573 lcov_list_full_path is non\-zero. | |
574 .br | |
575 | |
576 Default is 80. | |
577 .PP | |
578 | |
579 .BR lcov_list_truncate_max | |
580 .B " =" | |
581 .IR percentage | |
582 .IP | |
583 Specify the maximum percentage of file names which may be truncated when | |
584 choosing a directory prefix in list output. This value is ignored when | |
585 lcov_list_full_path is non\-zero. | |
586 .br | |
587 | |
588 Default is 20. | |
589 .PP | |
590 | |
591 .SH FILES | |
592 | |
593 .TP | |
594 .I /etc/lcovrc | |
595 The system\-wide | |
596 .B lcov | |
597 configuration file. | |
598 | |
599 .TP | |
600 .I ~/.lcovrc | |
601 The individual per\-user configuration file. | |
602 .PP | |
603 | |
604 .SH SEE ALSO | |
605 .BR lcov (1), | |
606 .BR genhtml (1), | |
607 .BR geninfo (1), | |
608 .BR gcov (1) | |
OLD | NEW |