Debian Codegraph @

lcovrc

raw
1 #
2 # /etc/lcovrc - system-wide defaults for LCOV
3 #
4 # To change settings for a single user, place a customized copy of this file
5 # at location ~/.lcovrc
6 #
7 # Note that this example script does not include all configuration options
8 # see 'man lcovrc(5) for a complete list and usage description.
9
10 # include some other config file
11 # e.g, user-specific options. Note the environment variable expansion
12 # config_file = $ENV{HOME}/.user_lcovrc
13 # or project specific - hard-coded from environment variable
14 # config_file = /path/to/myproject/.lcovrc
15 # or in the current run directory
16 # config_file = $ENV{PWD}/.lcovrc
17
18 # Specify an external style sheet file (same as --css-file option of genhtml)
19 #genhtml_css_file = gcov.css
20
21 # use 'dark' mode display (light foreground, dark background) instead of default
22 # same as 'genhtml --dark-mode ....'
23 #genhtml_dark_mode = 1
24
25 # Header text to use at top of each page
26 # Default is "LCOV - (differential )? coverage report"
27 #genhtml_header = Coverage report for my project
28
29 # Footer text to use at the bottom of each page
30 # Default is LCOV tool version
31 #genhtml_footer = My footer text
32
33 # Specify global coverage rate limits (in %) for classifying file entries
34 # HI: hi_limit <= rate <= 100 graph color: green
35 # MED: med_limit <= rate < hi_limit graph color: orange
36 # LO: 0 <= rate < med_limit graph color: red
37 genhtml_hi_limit = 90
38 genhtml_med_limit = 75
39
40 # Specify line coverage rate limits (in %) for classifying file entries
41 # HI: ln_hi_limit <= rate <= 100 graph color: green
42 # MED: ln_med_limit <= rate < ln_hi_limit graph color: orange
43 # LO: 0 <= rate < ln_med_limit graph color: red
44 # genhtml_line_hi_limit = 90
45 # genhtml_line_med_limit = 75
46
47 # Specify function coverage rate limits (in %) for classifying file entries
48 # HI: fn_hi_limit <= rate <= 100 graph color: green
49 # MED: fn_med_limit <= rate < fn_hi_limit graph color: orange
50 # LO: 0 <= rate < fn_med_limit graph color: red
51 # genhtml_function_hi_limit = 90
52 # genhtml_function_med_limit = 75
53
54 # Specify branch coverage rate limits (in %) for classifying file entries
55 # HI: br_hi_limit <= rate <= 100 graph color: green
56 # MED: br_med_limit <= rate < br_hi_limit graph color: orange
57 # LO: 0 <= rate < br_med_limit graph color: red
58 # genhtml_branch_hi_limit = 90
59 # genhtml_branch_med_limit = 75
60
61 # Ignore some errors during geninfo/lcov/genhtml processing - comma-separated
62 # string. Same as using "--ignore-errors a,b,c" command line option.
63 # See man pages for list of ignorable messages
64 #ignore_errors = empty,mismatch
65
66 # Stop emitting message after this number have been printed
67 # 0 == no limit
68 max_message_count = 100
69
70 # If set, do not stop when an 'ignorable error' occurs - try to generate
71 # a result, however flawed. This is equivalent to the '--keep-going'
72 # command line switch.
73 # Default is 1: stop when error occurs
74 # See the man pages for more detail
75 #stop_on_error = 1
76
77 # If nonzero, treat warnings as error
78 # note that ignored messages will still appear as warnings
79 # Default is 0
80 #treat_warning_as_error = 1
81
82 # If set to non-zero, only issue particluar warning once per file
83 # Default is 1
84 #warn_once_per_file = 1
85
86 # extension associated with lcov trace files - glob match pattern
87 # used as argument to 'find' - to find coverage files contained in
88 # a directory argument
89 #info_file_pattern = *.info
90
91 # List of file extensions which should be treated as RTL code (e.g., Verilog)
92 # Comma-separated list. Default is "v,vh,sv,vhd?"
93 #rtl_file_extensions = v,vh,sv,vhd?
94
95 # list of file extensions which should be treated as C/C++ code
96 # (comma-separated list)
97 #c_file_extensions = h,c,i,C,H,I,cpp,hpp,icc,cc,hh,cxx,hxx
98
99 # list of file extensions which should be treated as Java code
100 #java_file_extensions = java
101
102 # list of file extensions which should be treated as perl code
103 #perl_file_extensions = pl,pm
104
105 # list of file extensions which should be treated as python code
106 #python_file_extensions = py
107
108 # maximum number of lines to look at, when filtering bogus branch expressions
109 #filter_lookahead = 5
110
111 # if nonzero, bitwise operators '|', '&', '~' indicate conditional expressions
112 #filter_bitwise_conditional = 1
113
114 # if nonzero, '--filter blank' is applied to blank lines, regardless
115 # of their hit count
116 #filter_blank_aggressive = 1
117
118 # Width of line coverage field in source code view
119 genhtml_line_field_width = 12
120
121 # Width of branch coverage field in source code view
122 genhtml_branch_field_width = 16
123
124 # Width of MC/DC coverage field in source code view
125 genhtml_mcdc_field_width = 16
126
127 # width of 'owner' field in source code view - default is 20
128 #genhtml_owner_field_width = 20
129
130 # width of 'age' field in source code view - default is 5
131 #genhtml_age_field_width = 5
132
133 # Width of overview image (used by --frames option of genhtml)
134 genhtml_overview_width = 80
135
136 # Resolution of overview navigation: this number specifies the maximum
137 # difference in lines between the position a user selected from the overview
138 # and the position the source code window is scrolled to (used by --frames
139 # option of genhtml)
140 genhtml_nav_resolution = 4
141
142 # Clicking a line in the overview image should show the source code view at
143 # a position a bit further up so that the requested line is not the first
144 # line in the window. This number specifies that offset in lines (used by
145 # --frames option of genhtml)
146 genhtml_nav_offset = 10
147
148 # Do not remove unused test descriptions if non-zero (same as
149 # --keep-descriptions option of genhtml)
150 genhtml_keep_descriptions = 0
151
152 # Do not remove prefix from directory names if non-zero (same as --no-prefix
153 # option of genhtml)
154 genhtml_no_prefix = 0
155
156 # Do not create source code view if non-zero (same as --no-source option of
157 # genhtml)
158 genhtml_no_source = 0
159
160 # Replace tabs with number of spaces in source view (same as --num-spaces
161 # option of genhtml)
162 genhtml_num_spaces = 8
163
164 # Include color legend in HTML output if non-zero (same as --legend option of
165 # genhtml)
166 genhtml_legend = 0
167
168 # Use FILE as HTML prolog for generated pages (same as --html-prolog option of
169 # genhtml)
170 #genhtml_html_prolog = FILE
171
172 # Use FILE as HTML epilog for generated pages (same as --html-epilog option of
173 # genhtml)
174 #genhtml_html_epilog = FILE
175
176 # Use custom filename extension for pages (same as --html-extension option of
177 # genhtml)
178 #genhtml_html_extension = html
179
180 # Compress all generated html files with gzip.
181 #genhtml_html_gzip = 1
182
183 # Include sorted overview pages (can be disabled by the --no-sort option of
184 # genhtml)
185 genhtml_sort = 1
186
187 # Display coverage idata in hierarchical directory structure rather than
188 # top/directory/source
189 #genhtml_hierarchical = 1
190
191 # Display coverage data using 'flat' view: top-level table holds all
192 # files with no intermediate directory pages.
193 #genhtml_flat_view = 1
194
195 # Enable hyperlinks from coverage summary table to first source code line
196 # in corresponding category ('Hit' or "Missed') in non-differential report.
197 # Feature is always enabled in differential coverage report.
198 #genhtml_show_navigation = 1
199
200 # If nonzero, add column to "function coverage detail" table to show the proportion of lines and branches within the function which are exercised.
201 #genhtml_show_function_proportion = 0
202
203 # Specify the character set of all generated HTML pages
204 genhtml_charset=UTF-8
205
206 # Allow HTML markup in test case description text if non-zero
207 genhtml_desc_html=0
208
209 # Specify the precision for coverage rates
210 #genhtml_precision=1
211
212 # Show missed counts instead of hit counts
213 #genhtml_missed=1
214
215 # group function aliases in report - see '--merge' section in man(1) genhtml
216 #merge_function_aliasess = 1
217
218 # If set, suppress list of aliases in function detail table
219 #suppress_function_aliases = 1
220
221 # If set, derive function end line from line coverpoint data - default ON
222 #derive_function_end_line = 1
223
224 # If set, derive function end lines for all file types.
225 # By default, we derive end lines for C/C++ files only
226 #derive_end_line_all_files = 0
227
228 # Maximum size of function (number lines) which will be checked by '--filter trivial'
229 #trivial_function_threshold = 5
230
231 # Set threshold for hit count which tool should deem likely to indicate
232 # a toolchain bug (corrupt coverage data)
233 # excessive_count_theshold = number
234
235 # Demangle C++ symbols
236 # Call multiple times to specify command and command line arguments
237 # ('-Xlinker'-like behaviour)
238 #demangle_cpp = c++filt
239
240 # Name of the tool used for demangling C++ function names
241 # This argument is deprecated - please use 'demangle_cpp' instead
242 #genhtml_demangle_cpp_tool = c++filt
243 # Specify extra parameters to be passed to the demangling tool
244 # This argument is deprecated - please use 'demangle_cpp' instead
245 #genhtml_demangle_cpp_params = ""
246
247 # Location of the gcov tool (same as --gcov-info option of geninfo)
248 #geninfo_gcov_tool = gcov
249
250 # Adjust test names to include operating system information if non-zero
251 #geninfo_adjust_testname = 0
252
253 # Ignore testcase names in .info file
254 #forget_testcase_names = 0
255
256 # Calculate checksum for each source code line if non-zero (same as --checksum
257 # option of geninfo if non-zero, same as --no-checksum if zero)
258 #checksum = 1
259
260 # Specify whether to capture coverage data for external source files (can
261 # be overridden by the --external and --no-external options of geninfo/lcov)
262 #geninfo_external = 1
263
264 # Specify whether to capture coverage data from compile-time data files
265 # which have no corresponding runtime data.
266 #geninfo_capture_all = 1
267
268 # Enable libtool compatibility mode if non-zero (same as --compat-libtool option
269 # of geninfo if non-zero, same as --no-compat-libtool if zero)
270 #geninfo_compat_libtool = 0
271
272 # Use gcov's --all-blocks option if non-zero
273 #geninfo_gcov_all_blocks = 1
274
275 # Adjust 'executed' non-zero hit count of lines which contain no branches
276 # and have attribute '"unexecuted_blocks": true'
277 #geninfo_unexecuted_blocks = 0
278
279 # Specify compatibility modes (same as --compat option of geninfo).
280 #geninfo_compat = libtool=on, hammer=auto, split_crc=auto
281
282 # Adjust path to source files by removing or changing path components that
283 # match the specified pattern (Perl regular expression format)
284 #geninfo_adjust_src_path = /tmp/build => /usr/src
285
286 # Specify if geninfo should try to automatically determine the base-directory
287 # when collecting coverage data.
288 geninfo_auto_base = 1
289
290 # Use gcov intermediate format? Valid values are 0, 1, auto
291 geninfo_intermediate = auto
292
293 # Specify if exception branches should be excluded from branch coverage.
294 no_exception_branch = 0
295
296 # Directory containing gcov kernel files
297 # lcov_gcov_dir = /proc/gcov
298
299 # Location of the insmod tool
300 lcov_insmod_tool = /sbin/insmod
301
302 # Location of the modprobe tool
303 lcov_modprobe_tool = /sbin/modprobe
304
305 # Location of the rmmod tool
306 lcov_rmmod_tool = /sbin/rmmod
307
308 # Location for temporary directories
309 lcov_tmp_dir = /tmp
310
311 # Show full paths during list operation if non-zero (same as --list-full-path
312 # option of lcov)
313 lcov_list_full_path = 0
314
315 # Specify the maximum width for list output. This value is ignored when
316 # lcov_list_full_path is non-zero.
317 lcov_list_width = 80
318
319 # Specify the maximum percentage of file names which may be truncated when
320 # choosing a directory prefix in list output. This value is ignored when
321 # lcov_list_full_path is non-zero.
322 lcov_list_truncate_max = 20
323
324 # Specify if function coverage data should be collected, processed, and displayed
325 function_coverage = 1
326
327 # Specify if branch coverage data should be collected, processed, and displayed
328 branch_coverage = 0
329
330 # Specify if MC/DC coverage data should be collected, processed, and displayed
331 mcdc_coverage = 0
332
333 # Ask lcov/genhtml/geninfo to return non-zero exit code if branch coverage is below
334 # threshold
335 # Default is 0.0 - i.e., do not check threshold.
336 #fail_under_branches = 75.0
337
338 # Ask lcov/genhtml/geninfo to return non-zero exit code if line coverage is below
339 # threshold
340 # Default is 0.0 - i.e., do not check threshold.
341 #fail_under_lines = 97.5
342
343 # specify revision control annotation script for genhtml
344 #genhtml_annotate_script = path_to_my_executable
345
346 # specify the annotation popup that will appear if user hovers over source code
347 # set to empty to elide tooltip
348 # Substitutions:
349 # %d: line number
350 # %C: commit ID (from annotate callback - see --anotate-script entry in
351 # genhtml documentation)
352 # %U: commit author abbreviated name
353 # %F: commit author full name
354 # %D: commit date (as returned by annotate callback)
355 # %d: simplified commit date - yyyy-mm-dd part only (remove time of day)
356 # %A: commit age
357 # %l: line number
358 #genhtml_annotate_tooltip = Commit ID: %C by %F on %D
359
360 # specify coverage criteria script for genhtml/lcov/geninfo
361 #criteria_script = path_to_my_executable_or_module
362
363 # specify whether you want date and/or owner information passed to your criteria
364 # callback - in addition to summary information, which is always returned
365 #criteria_callback_data = date,owner
366
367 # specify when the criteria callback will be executed
368 #criteria_callback_levels = top,directory,file
369
370 # specify callback to decide whether particular source line should be
371 # included or suppresses
372 # select_script = path_to_exe | callback_parameter
373
374 # specify number of lines of context to include around each selected
375 # source line
376 # num_context_lines = 5
377
378 # specify age cutpoints for genhtml date bins
379 # can call option multiple times or use comma-separted list (or both)
380 #genhtml_date_bins = 7
381 #genhtml_date_bins = 30,180
382
383 # if enabled, show 'author' coverpoint summary table in page headers
384 # if not 'all', then show only authors who are responsible for coverpoints
385 # which are not hit
386 #genhtml_show_owner_table = 0 | 1 | all
387
388 # truncate owner table to show at most this many authors -
389 # subset will be those with the highest count of un-exercised code
390 # owner_table_entries = 5
391
392 # truncate the owner table at this level/these levels only
393 # possible values are 'file', 'directory', 'top' (without quotes)
394 # option may be specified multiple times and/or as a comma-separated list
395 # truncate_owner_table = top,directory,file
396
397 # if enabled, show author of non-code source lines (e.g., comments)
398 # in 'source' detail column
399 #genhtml_show_noncode_owners = 0 | 1
400
401 # if enabled, generate fake source code for missing files and out-of-range
402 # lines
403 #genhtml_synthesize_missing = 0 | 1
404
405
406 # ask geninfo/lcov/genhtml to include only certain files (glob match pattern)
407 # call multiple times to specify multiple patterns
408 #include = my/files/*.c
409 #include = my/files/*.h
410
411 # ask geninfo/lcov/genhtml to exclude certain files (glob match pattern)
412 # call multiple times to specify multiple patterns
413 #exclude = your/files/*.c
414 #exclude = your/files/*.h
415
416 # ask geninfo/lcov/genhtml to munge file pathnames when reading/writing .info files
417 # call multiple times to specify multiple patterns
418 # this pattern removes "/.lib" from the pathname (see the lcov man page for details)
419 #substitute = s#/.libs##g
420 # this pattern changes "/tmp/build" to "/usr/src" (see the lcov man page for details)
421 #substitute = s#/tmp/build#/usr/src#g
422
423 # ask geninfo/lcov/genhtml to exclude coverpoints associated with lines which match
424 # the regexp. Call multiple times to specify multiple patterns
425 # omit lines which end with "// MY_LINE_EXCLUDE_MARKER
426 #omit_lines = .+?//\s*MY_LINE_EXCLUDE_MARKER\s*
427 # add another exclusion marker
428 #omit_lines = .+?//\s*MY_PROJECT_EXCLUDE_MARKER\s*
429
430 # ask geninfo/lcov/genhtml to exclude coverpoints whose lines are within
431 # the start/end of a function matching the regexp.
432 #Call multiple times to specify multiple patterns
433 #erase_functions = main
434 # and another - note that this looks like a demangled C++ function
435 # that the argument is a regexp - so special characters need to be escaped
436 #erase_functions = debug)_.*\(int,\s*int\)
437
438 # check that source file exists before calling version-script, annotate-script
439 # or other callback. If set and file does not exist, 'source' error is
440 # generated. Default: 1 (check for existence).
441 #check_existence_before_callback = 1
442
443 # specify path to version identification script
444 #version_script = path_to_my_executable
445
446 # tell the tool to generate missing file version information when
447 # readind coverage DB file
448 # compute_file_version = 0 | 1
449
450 # specify path to file pathname resolution script
451 #resolve_script = path_to_my_executable
452
453 # Specify JSON module to use, or choose best available if set to auto
454 lcov_json_module = auto
455
456 # Specify maximum number of parallel slaves
457 # default: 1 (no parallelism)
458 #parallel = 1
459
460 # Specify maximum memory to use during parallel processing, in Mb.
461 # Do not fork if estimated memory consumption exceeds this number.
462 # default: 0 (no limit)
463 #memory = 1024
464
465 # Specify the number of consecutive fork() failures to allow before
466 # giving up
467 # max_fork_fails = 5
468
469 # Throttling control: the maximum number of files that genhtml will
470 # handle in a single (parallel) thread
471 # max_tasks_per_core = 20
472
473 # Seconds to wait after failing to fork() before retrying
474 # fork_fail_timeout = 10
475
476 # Throttling control: specify a percentage of system memory to use as
477 # maximum during parallel processing.
478 # Do not fork if estimated memory consumption exceeds the maximum.
479 # this value is used only if the maximum memory is not set.
480 # default: not set
481 #memory_percentage = 1024
482
483
484 # Character used to split list-type parameters
485 # - for example, the list of "--ignore_errors source,mismatch"
486 # default: , (comma)
487 #split_char = ,
488
489 # use case insensitive compare to find matching files, for include/exclude
490 # directives, etc
491 #case_insensitive = 0
492
493 # sort file names before capture and/or aggregation - to reduce certain
494 # types of processing order dependencies which can affect coverage results.
495 # see the lcovrc man page for more details.
496 #sort_input = 1
497
498 # override line default line exclusion regexp
499 #lcov_excl_line = LCOV_EXCL_LINE
500
501 # override branch exclusion regexp
502 #lcov_excl_br_line = LCOV_EXCL_BR_LINE
503
504 # override exception branch exclusion regexp
505 #lcov_excl_exception_br_line = LCOV_EXCL_EXCEPTION_BR_LINE
506
507 # override start of exclude region regexp
508 #lcov_excl_start = LCOV_EXCL_START
509
510 # override end of exclude region regexp
511 #lcov_excl_stop = LCOV_EXCL_STOP
512
513 # override start of branch exclude region regexp
514 #lcov_excl_br_start = LCOV_EXCL_BR_START
515
516 # override start of exclude region regexp
517 #lcov_excl_br_stop = LCOV_EXCL_BR_STOP
518
519 # override start of exclude region regexp
520 #lcov_excl_exception_br_start = LCOV_EXCL_EXCEPTION_BR_START
521
522 # override start of exclude region regexp
523 #lcov_excl_exception_br_stop = LCOV_EXCL_EXCEPTION_BR_STOP