Coverage Options

Coverage Data Files

A space-delimited list of coverage files to merge and report on. Accepts wildcards.

Usage: ncover.reporting.exe coverage\10.2.09*.xml

Append Trend to a File

Appends trend data from the merged coverage files to the specified output path and filename. The file will be created if it does not exist. If this parameter is specified and LoadTrendPath is not, then this file will provide trend data for the reports. Otherwise, the file specified by LoadTrendPath will provide trend data for the reports. If both CoverageTrendPath and LoadTrendPath are specified, then the trend data from the merged coverage files will be appended to the path in CoverageTrendPath before the trend data for the reports is loaded from LoadTrendPath. (If CoverageTrendPath and LoadTrendPath are the same full path and filename, then LoadTrendPath)

Usage:
//at "C:\data\trends\myproject.trend"

Build Id

Specify the build ID for the MergedCoverageDataFileName. Defaults to the build ID of the first coverage data file loaded.

Usage:
//bi myproject_3.0.12.3721

Hide

Specify what elements to hide (if any) in the report. These elements will still exist and affect coverage percentages, but they will not appear.
Possible Values:
None (default)
HideUnvisited
HideFullyCovered
HideThresholdCovered

Usage:
//hi HideUnvisited

Ignore Failed Builds

By default, reports with trend data will include trend data from builds that had failing tests. However, you can make the reports act as if that data doesn't exist by using this argument or setting it to true. Using this argument will make the reports only use trend data from builds that had no failing tests.

Usage:
//ifb 

Load Trend from a File

Rather than creating new trends from the coverage data, this parameter loads trend data for the report from the specified output path and filename, and uses the trend data in the given file without appending trend data from the merged coverage files.

Usage:
//lt "C:\data\trends\myproject.trend"

Output Path

Specify the default output path for all generated reports. Defaults to the current directory.
NOTE: this parameter is interpreted as a directory for the 'FullCoverageReport' and as a file for every other report.

Usage:
//op "D:\reports\html\fullcoverage10.2.09"

Output Report

The Reports option allows you to create multiple reports using the same filters, satisfactory thresholds, and sort order, giving you multiple views of the same data.

Usage: //or report type[:format][:output path] [params ( name=value, ... , name=value )]

'report type' is the type of report to create
Possible Values:
FullCoverageReport (HTML only, //op will be interpreted as a folder)
Summary (HTML only)
UncoveredCodeSections (HTML only)
SymbolSourceCode
SymbolSourceCodeClass
SymbolSourceCodeClassMethod
MethodSourceCode
MethodSourceCodeClass
MethodSourceCodeClassMethod
SymbolModule
SymbolModuleNamespace
SymbolModuleNamespaceClass
SymbolModuleNamespaceClassMethod
SymbolCCModuleClassFailedCoverageTop
SymbolCCModuleClassCoverageTop
MethodModule
MethodModuleNamespace
MethodModuleNamespaceClass
MethodModuleNamespaceClassMethod
MethodCCModuleClassFailedCoverageTop
MethodCCModuleClassCoverageTop
Trends
Diff

'format' specifies whether the output file(s) is in Xml or Html
Possible Values: "Xml" -or- "Html"

'output path' is where the report will be created. If it's not specified, then the value of OutputPath will be used.

The 'params ( ... )' construt accepts a list of names or name-value pairs separated by commas. A name and a value are separated by an equal sign ('='). A name or a value must be at least one character long; all valid Unicode characters are legal, with the exception of '=' (equal sign), ',' (comma), '(' (left parenthesis), and ')' (right-parenthesis). In addition, leading and trailing whitespace, single-quotes, and double-quotes will be trimmed from both names and values before they are processed by the reporting engine.

Although all name-value pairs will be read from the command line and stored, what each name means (and which values are valid) is defined by each report type. To find out what names mean and which names are supported by each report, consult the documentation page for each report type. Before name-value pairs are passed to the reporting engine, names are converted to lowercase (i.e NAME=VaLue becomes name=VaLue before it is passed to the reporting engine).

Example 'params ( ... )' constructs

Create an empty name-value list
//or ... params ( )

Create a list with a single name
//or ... params ( hello )

Create a list with a single name-value pair
//or ... params ( hello=world)

Create a list with multiple name-value pairs
//or ... params (hello = my world, verbose, name1 = value1 , \"hi\"= 'there' )

An invalid format example
// or ... params (hello = world
(no closing right-parenthesis ')')

An invalid format example
//or ... params ( hello= )
(no value after the equal sign '=')

An invalid format example
//or ... params ( hello= world, )
(no name after the comma ',')

An invalid format example
//or ... params hello = world )
(no opening left-parenthesis '(')

An invalid format example
//or ... params ( hel,lo=world )
(not technically invalid, this will parse as two name-value pairs, "hel" and "lo=world")

An invalid format example
//or ... ( hello=world )
(not technically invalid, but probably unintended, this will parse as an empty params list, since there is no 'params' to signal the beginning of the list)

Project Name

Set this value to control the project name that appears at the top of every generated report. By default, the project name is taken from the first coverage file loaded.

Usage:
//p "my very long project name"

Sort By

Specifies the sorting to apply to the reports. Default is no sorting.
Permitted values:
Name
ClassLine
CoveragePercentageAscending
CoveragePercentageDescending
UnvisitedSequencePointsAscending
UnvisitedSequencePointsDescending
VisitCountAscending
VisitCountDescending
FunctionCoverageAscending
FunctionCoverageDescending

Usage:
//so VisitCountDescending

Top Uncovered to Report

By default, NCover.Reporting only reports the top 10 most uncovered items in the "Top Uncovered" reports. Set this value to control how many are shown.

Usage:
//tu 50

Xslt Override Path

You may provide the path to the Xslt file you wish to use for the report.

Usage:
//xslt mycustomfile.xslt

Questions? Comments?

Contact us.