1lcovrc(5) User Manuals lcovrc(5)
2
6 lcovrc - lcov configuration file
7
10 The lcovrc file contains configuration information for the lcov code
11 coverage tool (see lcov(1)).
12 The system-wide configuration file is located at /etc/lcovrc. To
14 change settings for a single user, place a customized copy of this file
15 at location ~/.lcovrc. Where available, command-line options override
16 configuration file settings.
17 Lines in a configuration file can either be:
19 * empty lines or lines consisting only of white space characters.
21 These lines are ignored.
22 * comment lines which start with a hash sign ('#'). These are
24 treated like empty lines and will be ignored.
25 * statements in the form 'key = value'. A list of valid state‐
27 ments and their description can be found in section 'OPTIONS'
28 below.
29 Example configuration:
31 #
33 # Example LCOV configuration file
34 #
35 # External style sheet file
37 #genhtml_css_file = gcov.css
38 # Coverage rate limits for line coverage
40 genhtml_hi_limit = 50
41 genhtml_med_limit = 15
42 # Coverage rate limits for function coverage
44 genhtml_function_hi_limit = 90
45 genhtml_function_med_limit = 75
46 # Width of overview image
48 genhtml_overview_width = 80
49 # Resolution of overview navigation
51 genhtml_nav_resolution = 4
52 # Offset for source code navigation
54 genhtml_nav_offset = 10
55 # Do not remove unused test descriptions if non-zero
57 genhtml_keep_descriptions = 0
58 # Do not remove prefix from directory names if non-zero
60 genhtml_no_prefix = 0
61 # Do not create source code view if non-zero
63 genhtml_no_source = 0
64 # Specify size of tabs
66 genhtml_num_spaces = 8
67 # Highlight lines with converted-only data if non-zero
69 genhtml_highlight = 0
70 # Include color legend in HTML output if non-zero
72 genhtml_legend = 0
73 # Include HTML file at start of HTML output
75 #genhtml_html_prolog = prolog.html
76 # Include HTML file at end of HTML output
78 #genhtml_html_epilog = epilog.html
79 # Use custom HTML file extension
81 #genhtml_html_extension = html
82 # Compress all generated html files with gzip.
84 #genhtml_html_gzip = 1
85 # Include sorted overview pages
87 genhtml_sort = 1
88 # Include function coverage data display
90 genhtml_function_coverage = 1
91 # Location of the gcov tool
93 #geninfo_gcov_tool = gcov
94 # Adjust test names if non-zero
96 #geninfo_adjust_testname = 0
97 # Calculate a checksum for each line if non-zero
99 geninfo_checksum = 0
100 # Enable libtool compatibility mode if non-zero
102 geninfo_compat_libtool = 0
103 # Directory containing gcov kernel files
105 lcov_gcov_dir = /proc/gcov
106 # Location of the insmod tool
108 lcov_insmod_tool = /sbin/insmod
109 # Location of the modprobe tool
111 lcov_modprobe_tool = /sbin/modprobe
112 # Location of the rmmod tool
114 lcov_rmmod_tool = /sbin/rmmod
115 # Location for temporary directories
117 lcov_tmp_dir = /tmp
118
120 genhtml_css_file = filename
121 Specify an external style sheet file. Use this option to modify
123 the appearance of the HTML output as generated by genhtml. Dur‐
124 ing output generation, a copy of this file will be placed in the
125 output directory.
126 This option corresponds to the --css-file command line option of
128 genhtml.
129 By default, a standard CSS file is generated.
131 genhtml_hi_limit = hi_limit
133 genhtml_med_limit = med_limit
134 genhtml_function_med_limit = hi_limit
135 genhtml_function_med_limit = med_limit
136 Specify coverage rate limits for classifying file entries. Use
138 this option to modify the coverage rates (in percent) for line
139 or function coverage at which a result is classified as high,
140 medium or low coverage. This classification affects the color of
141 the corresponding entries on the overview pages of the HTML out‐
142 put:
143 High: hi_limit <= rate <= 100 default color: green
145 Medium: med_limit <= rate < hi_limit default color: orange
146 Low: 0 <= rate < med_limit default color: red
147 Defaults are 50 and 15 percent for line coverage and 90 and 75
149 percent for function coverage.
150 genhtml_overview_width = pixel_size
152 Specify the width (in pixel) of the overview image created when
154 generating HTML output using the --frames option of genhtml.
155 Default is 80.
157 genhtml_nav_resolution = lines
159 Specify the resolution of overview navigation when generating
161 HTML output using the --frames option of genhtml. This number
162 specifies the maximum difference in lines between the position a
163 user selected from the overview and the position the source code
164 window is scrolled to.
165 Default is 4.
167 genhtml_nav_offset = lines
169 Specify the overview navigation line offset as applied when gen‐
171 erating HTML output using the --frames option of genhtml.
172 Clicking a line in the overview image should show the source
174 code view at a position a bit further up, so that the requested
175 line is not the first line in the window. This number specifies
176 that offset.
177 Default is 10.
179 genhtml_keep_descriptions = 0|1
181 If non-zero, keep unused test descriptions when generating HTML
183 output using genhtml.
184 This option corresponds to the --keep-descriptions option of
186 genhtml.
187 Default is 0.
189 genhtml_no_prefix = 0|1
191 If non-zero, do not try to find and remove a common prefix from
193 directory names.
194 This option corresponds to the --no-prefix option of genhtml.
196 Default is 0.
198 genhtml_no_source = 0|1
200 If non-zero, do not create a source code view when generating
202 HTML output using genhtml.
203 This option corresponds to the --no-source option of genhtml.
205 Default is 0.
207 genhtml_num_spaces = num
209 Specify the number of spaces to use as replacement for tab char‐
211 acters in the HTML source code view as generated by genhtml.
212 This option corresponds to the --num-spaces option of genthml.
214 Default is 8.
216 genhtml_highlight = 0|1
219 If non-zero, highlight lines with converted-only data in HTML
221 output as generated by genhtml.
222 This option corresponds to the --highlight option of genhtml.
224 Default is 0.
226 genhtml_legend = 0|1
228 If non-zero, include a legend explaining the meaning of color
230 coding in the HTML output as generated by genhtml.
231 This option corresponds to the --legend option of genhtml.
233 Default is 0.
235 genhtml_html_prolog = filename
237 If set, include the contents of the specified file at the begin‐
239 ning of HTML output.
240 This option corresponds to the --html-prolog option of genhtml.
242 Default is to use no extra prolog.
244 genhtml_html_epilog = filename
246 If set, include the contents of the specified file at the end of
248 HTML output.
249 This option corresponds to the --html-epilog option of genhtml.
251 Default is to use no extra epilog.
253 genhtml_html_extension = extension
255 If set, use the specified string as filename extension for gen‐
257 erated HTML files.
258 This option corresponds to the --html-extension option of gen‐
260 html.
261 Default extension is "html".
263 genhtml_html_gzip = 0|1
265 If set, compress all html files using gzip.
267 This option corresponds to the --html-gzip option of genhtml.
269 Default extension is 0.
271 genhtml_sort = 0|1
273 If non-zero, create overview pages sorted by coverage rates when
275 generating HTML output using genhtml.
276 This option can be set to 0 by using the --no-sort option of
278 genhtml.
279 Default is 1.
281 genhtml_function_coverage = 0|1
283 If non-zero, include function coverage data when generating HTML
285 output using genhtml.
286 This option can be set to 0 by using the --no-function-coverage
288 option of genhtml.
289 Default is 1.
291 geninfo_gcov_tool = path_to_gcov
293 Specify the location of the gcov tool (see gcov(1)) which is
295 used to generate coverage information from data files.
296 Default is 'gcov'.
298 geninfo_adjust_testname = 0|1
300 If non-zero, adjust test names to include operating system
302 information when capturing coverage data.
303 Default is 0.
305 geninfo_checksum = 0|1
307 If non-zero, generate source code checksums when capturing cov‐
309 erage data. Checksums are useful to prevent merging coverage
310 data from incompatible source code versions but checksum genera‐
311 tion increases the size of coverage files and the time used to
312 generate those files.
313 This option corresponds to the --checksum and --no-checksum com‐
315 mand line option of geninfo.
316 Default is 0.
318 geninfo_compat_libtool = 0|1
320 If non-zero, enable libtool compatibility mode. When libtool
322 compatibility mode is enabled, lcov will assume that the source
323 code relating to a .da file located in a directory named ".libs"
324 can be found in its parent directory.
325 This option corresponds to the --compat-libtool and --no-com‐
327 pat-libtool command line option of geninfo.
328 Default is 1.
330 lcov_gcov_dir = path_to_kernel_coverage_data
332 Specify the path to the directory where kernel coverage data can
334 be found.
335 Default is '/proc/gcov'.
337 lcov_insmod_tool = path_to_insmod
339 Specify the location of the insmod tool used to load kernel mod‐
341 ules.
342 Default is '/sbin/insmod'.
344 lcov_modprobe_tool = path_to_modprobe
346 Specify the location of the modprobe tool used to load kernel
348 modules.
349 Default is '/sbin/modprobe'.
351 lcov_rmmod_tool = path_to_rmmod
353 Specify the location of the rmmod tool used to unload kernel
355 modules.
356 Default is '/sbin/rmmod'.
358 lcov_tmp_dir = temp
360 Specify the location of a directory used for temporary files.
362 Default is '/tmp'.
364
366 /etc/lcovrc
367 The system-wide lcov configuration file.
368 ~/.lcovrc
371 The individual per-user configuration file.
372
374 lcov(1), genhtml(1), geninfo(1), gcov(1)
3752008-11-17 LCOV 1.7 lcovrc(5)