lcovrc - lcov configuration file

The lcovrc file contains configuration information for the lcov code coverage tool (see lcov(1)).

The system-wide configuration file is located at /etc/lcovrc. To change settings for a single user, place a customized copy of this file at location ~/.lcovrc. Where available, command-line options override configuration file settings.

Lines in a configuration file can either be:

*

empty lines or lines consisting only of white space characters. These lines are ignored.

*

comment lines which start with a hash sign ('#'). These are treated like empty lines and will be ignored.

*

statements in the form 'key = value'. A list of valid statements and their description can be found in section 'OPTIONS' below.

Example configuration:

#

# Example LCOV configuration file

#

# External style sheet file

#genhtml_css_file = gcov.css

# Coverage rate limits

genhtml_hi_limit = 50

genhtml_med_limit = 15

# Width of overview image

genhtml_overview_width = 80

# Resolution of overview navigation

genhtml_nav_resolution = 4;

# Offset for source code navigation

genhtml_nav_offset = 10;

# Do not remove unused test descriptions if non-zero

genhtml_keep_descriptions = 0

# Do not remove prefix from directory names if non-zero

genhtml_no_prefix = 0

# Do not create source code view if non-zero

genhtml_no_source = 0

# Specify size of tabs

genhtml_num_spaces = 8

# Highlight lines with converted-only data if non-zero

genhtml_highlight = 0

# Location of the gcov tool

#geninfo_gcov_tool = gcov

# Adjust test names if non-zero

#geninfo_adjust_testname = 0

# Do not calculate a checksum for each line if non-zero

geninfo_no_checksum = 0

# Directory containing gcov kernel files

lcov_gcov_dir = /proc/gcov

# Location of the insmod tool

lcov_insmod_tool = /sbin/insmod

# Location of the modprobe tool

lcov_modprobe_tool = /sbin/modprobe

# Location of the rmmod tool

lcov_rmmod_tool = /sbin/rmmod

# Location for temporary directories

lcov_tmp_dir = /tmp

genhtml_css_file = filename

Specify an external style sheet file. Use this option to modify the appearance of the HTML output as generated by genhtml. During output generation, a copy of this file will be placed in the output directory.

This option corresponds to the --css-file command line option of genhtml.

By default, a standard CSS file is generated.

genhtml_hi_limit = hi_limit

genhtml_med_limit = med_limit

Specify coverage rate limits for classifying file entries. Use this option to modify the coverage rates (in percent) at which a result is classified as high, medium or low coverage. This classification affects the color of the corresponding entries on the overview pages of the HTML output:

High: hi_limit <= rate <= 100 default color: green

Medium: med_limit <= rate < hi_limit default color: orange

Low: 0 <= rate < med_limit default color: red

Defaults are 50 and 15 respectively.

genhtml_overview_width = pixel_size

Specify the width (in pixel) of the overview image created when generating HTML output using the --frames option of genhtml.

Default is 80.

genhtml_nav_resolution = lines

Specify the resolution of overview navigation when generating HTML output using the --frames option of genhtml. This number specifies the maximum difference in lines between the position a user selected from the overview and the position the source code window is scrolled to.

Default is 4.

genhtml_nav_offset = lines

Specify the overview navigation line offset as applied when generating HTML output using the --frames option of genhtml.

Clicking a line in the overview image should show the source code view at a position a bit further up, so that the requested line is not the first line in the window. This number specifies that offset.

Default is 10.

genhtml_keep_descriptions = 0|1

If non-zero, keep unused test descriptions when generating HTML output using genhtml.

This option corresponds to the --keep-descriptions option of genhtml.

Default is 0.

genhtml_no_prefix = 0|1

If non-zero, do not try to find and remove a common prefix from directory names.

This option corresponds to the --no-prefix option of genhtml.

Default is 0.

genhtml_no_source = 0|1

If non-zero, do not create a source code view when generating HTML output using genhtml.

This option corresponds to the --no-source option of genhtml.

Default is 0.

genhtml_num_spaces = num

Specify the number of spaces to use as replacement for tab characters in the HTML source code view as generated by genhtml.

This option corresponds to the --num-spaces option of genthml.

Default is 8.

genhtml_highlight = 0|1

If non-zero, highlight lines with converted-only data in HTML output as generated by genhtml.

This option corresponds to the --highlight option of genhtml.

Default is 0.

geninfo_gcov_tool = path_to_gcov

Specify the location of the gcov tool (see gcov(1)) which is used to generate coverage information from data files.

Default is 'gcov'.

geninfo_adjust_testname = 0|1

If non-zero, adjust test names to include operating system information when capturing coverage data.

Default is 0.

geninfo_no_checksum = 0|1

If non-zero, do not create source code checksums when capturing coverage data. Checksums are useful to prevent merging coverage data from incompatible source code versions.

This option corresponds to the --no-checksum command line option of geninfo.

Default is 0.

lcov_gcov_dir = path_to_kernel_coverage_data

Specify the path to the directory where kernel coverage data can be found.

Default is '/proc/gcov'.

lcov_insmod_tool = path_to_insmod

Specify the location of the insmod tool used to load kernel modules.

Default is '/sbin/insmod'.

lcov_modprobe_tool = path_to_modprobe

Specify the location of the modprobe tool used to load kernel modules.

Default is '/sbin/modprobe'.

lcov_rmmod_tool = path_to_rmmod

Specify the location of the rmmod tool used to unload kernel modules.

Default is '/sbin/rmmod'.

lcov_tmp_dir = temp

Specify the location of a directory used for temporary files.

Default is '/tmp'.

/etc/lcovrc

The system-wide lcov configuration file.

~/.lcovrc

The individual per-user configuration file.

lcov(1), genhtml(1), geninfo(1), gcov(1)