BullseyeCoverage Up Contents Search

covclass, covdir, covfn, covsrc - Summarize Coverage

covclass [options] [region ...]
covdir [options] [region ...]
covfn [options] [region ...]
covsrc [options] [region ...]

Description

These commands produce a coverage report summarizing measurements grouped by C++ class or namespace (covclass), by source file directory (covdir), by function (covfn), or by source file (covsrc). With no arguments, the commands display measurements for all analyzed source. Otherwise, they report measurements in each source region. For more information, see Regions.

covfn shows the information listed below under the indicated heading names.

Function - function name
Source - source filename, relative to the current directory
Line - line number within the source file
Function Coverage - function coverage, indicating whether the function was invoked or not
C/D Coverage - condition/decision coverage for the function

The other commands show the information listed below under the indicated heading names.

Directory - directory filename, relative to the current directory
Source - source filename, relative to the current directory
Class - C++ class or namespace identifier
Function Coverage - function coverage for the region
C/D Coverage - condition/decision coverage for the region

By default, the programs sort the report so that the least covered groups appear first. They sort first by function coverage then by the condition/decision coverage.

You can specify command line arguments in a file using the syntax @filename.

Options

`-b`	`--base`	Show the file basename rather than full path. This removes the directory component of filenames shown. Use this option to reduce the width of the report. (`covfn` and `covsrc` only.)
`-c`	`--csv`	Output comma separated values. Use this option to export coverage measurements into another program such as a spreadsheet. The report width has no effect with this option.
`-d`Dir	`--srcdir` Dir	Display source files names relative to directory Dir rather than relative to the directory where the coverage file is located. You can display the source file names the same way they appear in the Coverage Browser using "`-d.`".
`-f`Path	`--file` Path	The coverage file is specified by Path. The default is `test.cov`.
`-h`	`--help`	Display a summary of options.
`-k`	`--no-head`	Suppress column headings and totals.
`-m`	`--by-name`	Sort by C++ class or namespace (`covclass`), by directory (`covdir`), by function name (`covfn`), or by source file name (`covsrc`).
`-n`	`--no-source`	Suppress the source file and line number columns. Use this option to reduce the width of the report. (`covfn` only.)
`-p`	`--by-pcnt`	Sort by the coverage percentage. This is the default sorting method.
`-q`	`--quiet`	Suppress warnings and the copyright message.
`-r`	`--reverse`	Reverse sort.
`-s`	`--by-source`	Sort by source filename and line (`covfn` only).
`-u`	`--by-uncov`	Sort by number of uncovered events.
`-v`	`--verbose`	Show informational messages.
`-w`N	`--width` N	Limit the report width to N columns.
`--checkmin` N`,`M		If function coverage is less than N% or condition/decision coverage is less than M%, exit with error status. No report is output. This option is recognized by `covdir` only.
`--decision`		Show decision coverage rather than condition/decision coverage. This option is not recommended; decision coverage may report uncovered code as covered. Use this option only to compare results with other projects or other tools which cannot provide condition/decision coverage.
`--html`		Output in HTML format. This option is deprecated. See covhtml.
`--no-banner`		Suppress startup banner

Environment Variables

`COVFILE`	The coverage file. Option `-f` (`--file`) overrides this setting.
`COVSRCDIR`	The source file directory. Option `-d` (`--srcdir`) overrides this setting.
`COVCLASSCFG`	Configuration file. See FILES.
`COVDIRCFG`	Configuration file. See FILES.
`COVFNCFG`	Configuration file. See FILES.
`COVSRCCFG`	Configuration file. See FILES.

Files

If the files listed below exist, they contain initial options separated by white space. Within these files, $NAME is replaced by the value of the environment variable named NAME.

BullseyeCoverage/bin/covclass.cfg
BullseyeCoverage/bin/covdir.cfg
BullseyeCoverage/bin/covfn.cfg
BullseyeCoverage/bin/covsrc.cfg
home-directory/covclass.cfg
home-directory/covdir.cfg
home-directory/covfn.cfg
home-directory/covsrc.cfg

Updated: 27 Sep 2023