1LCOVRC(5) File Formats Manual 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
40 genhtml_hi_limit = 50
41 genhtml_med_limit = 15
42 # Width of overview image
44 genhtml_overview_width = 80
45 # Resolution of overview navigation
47 genhtml_nav_resolution = 4
48 # Offset for source code navigation
50 genhtml_nav_offset = 10
51 # Do not remove unused test descriptions if non-zero
53 genhtml_keep_descriptions = 0
54 # Do not remove prefix from directory names if non-zero
56 genhtml_no_prefix = 0
57 # Do not create source code view if non-zero
59 genhtml_no_source = 0
60 # Specify size of tabs
62 genhtml_num_spaces = 8
63 # Highlight lines with converted-only data if non-zero
65 genhtml_highlight = 0
66 # Include color legend in HTML output if non-zero
68 genhtml_legend = 0
69 # Include HTML file at start of HTML output
71 #genhtml_html_prolog = prolog.html
72 # Include HTML file at end of HTML output
74 #genhtml_html_epilog = epilog.html
75 # Use custom HTML file extension
77 #genhtml_html_extension = html
78 # Location of the gcov tool
80 #geninfo_gcov_tool = gcov
81 # Adjust test names if non-zero
83 #geninfo_adjust_testname = 0
84 # Calculate a checksum for each line if non-zero
86 geninfo_checksum = 0
87 # Enable libtool compatibility mode if non-zero
89 geninfo_compat_libtool = 0
90 # Directory containing gcov kernel files
92 lcov_gcov_dir = /proc/gcov
93 # Location of the insmod tool
95 lcov_insmod_tool = /sbin/insmod
96 # Location of the modprobe tool
98 lcov_modprobe_tool = /sbin/modprobe
99 # Location of the rmmod tool
101 lcov_rmmod_tool = /sbin/rmmod
102 # Location for temporary directories
104 lcov_tmp_dir = /tmp
105
107 genhtml_css_file = filename
108 Specify an external style sheet file. Use this option to modify
110 the appearance of the HTML output as generated by genhtml. Dur‐
111 ing output generation, a copy of this file will be placed in the
112 output directory.
113 This option corresponds to the --css-file command line option of
115 genhtml.
116 By default, a standard CSS file is generated.
118 genhtml_hi_limit = hi_limit
120 genhtml_med_limit = med_limit
121 Specify coverage rate limits for classifying file entries. Use
123 this option to modify the coverage rates (in percent) at which a
124 result is classified as high, medium or low coverage. This clas‐
125 sification affects the color of the corresponding entries on the
126 overview pages of the HTML output:
127 High: hi_limit <= rate <= 100 default color: green
129 Medium: med_limit <= rate < hi_limit default color: orange
130 Low: 0 <= rate < med_limit default color: red
131 Defaults are 50 and 15 respectively.
133 genhtml_overview_width = pixel_size
135 Specify the width (in pixel) of the overview image created when
137 generating HTML output using the --frames option of genhtml.
138 Default is 80.
140 genhtml_nav_resolution = lines
142 Specify the resolution of overview navigation when generating
144 HTML output using the --frames option of genhtml. This number
145 specifies the maximum difference in lines between the position a
146 user selected from the overview and the position the source code
147 window is scrolled to.
148 Default is 4.
150 genhtml_nav_offset = lines
152 Specify the overview navigation line offset as applied when gen‐
154 erating HTML output using the --frames option of genhtml.
155 Clicking a line in the overview image should show the source
157 code view at a position a bit further up, so that the requested
158 line is not the first line in the window. This number specifies
159 that offset.
160 Default is 10.
162 genhtml_keep_descriptions = 0|1
164 If non-zero, keep unused test descriptions when generating HTML
166 output using genhtml.
167 This option corresponds to the --keep-descriptions option of
169 genhtml.
170 Default is 0.
172 genhtml_no_prefix = 0|1
174 If non-zero, do not try to find and remove a common prefix from
176 directory names.
177 This option corresponds to the --no-prefix option of genhtml.
179 Default is 0.
181 genhtml_no_source = 0|1
183 If non-zero, do not create a source code view when generating
185 HTML output using genhtml.
186 This option corresponds to the --no-source option of genhtml.
188 Default is 0.
190 genhtml_num_spaces = num
192 Specify the number of spaces to use as replacement for tab char‐
194 acters in the HTML source code view as generated by genhtml.
195 This option corresponds to the --num-spaces option of genthml.
197 Default is 8.
199 genhtml_highlight = 0|1
202 If non-zero, highlight lines with converted-only data in HTML
204 output as generated by genhtml.
205 This option corresponds to the --highlight option of genhtml.
207 Default is 0.
209 genhtml_legend = 0|1
211 If non-zero, include a legend explaining the meaning of color
213 coding in the HTML output as generated by genhtml.
214 This option corresponds to the --legend option of genhtml.
216 Default is 0.
218 genhtml_html_prolog = filename
220 If set, include the contents of the specified file at the begin‐
222 ning of HTML output.
223 This option corresponds to the --html-prolog option of genhtml.
225 Default is to use no extra prolog.
227 genhtml_html_epilog = filename
229 If set, include the contents of the specified file at the end of
231 HTML output.
232 This option corresponds to the --html-epilog option of genhtml.
234 Default is to use no extra epilog.
236 genhtml_html_extension = extension
238 If set, use the specified string as filename extension for gen‐
240 erated HTML files.
241 This option corresponds to the --html-extension option of gen‐
243 html.
244 Default extension is "html".
246 geninfo_gcov_tool = path_to_gcov
248 Specify the location of the gcov tool (see gcov(1)) which is
250 used to generate coverage information from data files.
251 Default is 'gcov'.
253 geninfo_adjust_testname = 0|1
255 If non-zero, adjust test names to include operating system
257 information when capturing coverage data.
258 Default is 0.
260 geninfo_checksum = 0|1
262 If non-zero, generate source code checksums when capturing cov‐
264 erage data. Checksums are useful to prevent merging coverage
265 data from incompatible source code versions but checksum genera‐
266 tion increases the size of coverage files and the time used to
267 generate those files.
268 This option corresponds to the --checksum and --no-checksum com‐
270 mand line option of geninfo.
271 Default is 0.
273 geninfo_compat_libtool = 0|1
275 If non-zero, enable libtool compatibility mode. When libtool
277 compatibility mode is enabled, lcov will assume that the source
278 code relating to a .da file located in a directory named ".libs"
279 can be found in its parent directory.
280 This option corresponds to the --compat-libtool and --no-com‐
282 pat-libtool command line option of geninfo.
283 Default is 1.
285 lcov_gcov_dir = path_to_kernel_coverage_data
287 Specify the path to the directory where kernel coverage data can
289 be found.
290 Default is '/proc/gcov'.
292 lcov_insmod_tool = path_to_insmod
294 Specify the location of the insmod tool used to load kernel mod‐
296 ules.
297 Default is '/sbin/insmod'.
299 lcov_modprobe_tool = path_to_modprobe
301 Specify the location of the modprobe tool used to load kernel
303 modules.
304 Default is '/sbin/modprobe'.
306 lcov_rmmod_tool = path_to_rmmod
308 Specify the location of the rmmod tool used to unload kernel
310 modules.
311 Default is '/sbin/rmmod'.
313 lcov_tmp_dir = temp
315 Specify the location of a directory used for temporary files.
317 Default is '/tmp'.
319
321 /etc/lcovrc
322 The system-wide lcov configuration file.
323 ~/.lcovrc
326 The individual per-user configuration file.
327
329 lcov(1), genhtml(1), geninfo(1), gcov(1)
330 Mar 07 2005 LCOVRC(5)