From 589e210e740bbf243cb0e57acbff7bf4e1ea8a66 Mon Sep 17 00:00:00 2001 From: Marco Rossignoli Date: Thu, 26 Sep 2019 10:12:42 +0200 Subject: [PATCH] Update "mergewith" doc (#568) Update "mergewith" doc --- Documentation/GlobalTool.md | 2 ++ Documentation/MSBuildIntegration.md | 3 ++- Documentation/VSTestIntegration.md | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Documentation/GlobalTool.md b/Documentation/GlobalTool.md index c17f9b3..78a0e5c 100644 --- a/Documentation/GlobalTool.md +++ b/Documentation/GlobalTool.md @@ -38,6 +38,8 @@ Options: --use-source-link Specifies whether to use SourceLink URIs in place of file system paths. ``` +For `--merge-with` [check the sample](Examples.md). + ## Code Coverage The `coverlet` tool is invoked by specifying the path to the assembly that contains the unit tests. You also need to specify the test runner and the arguments to pass to the test runner using the `--target` and `--targetargs` options respectively. The invocation of the test runner with the supplied arguments **must not** involve a recompilation of the unit test assembly or no coverage data will be generated. diff --git a/Documentation/MSBuildIntegration.md b/Documentation/MSBuildIntegration.md index b94e986..4a6b97d 100644 --- a/Documentation/MSBuildIntegration.md +++ b/Documentation/MSBuildIntegration.md @@ -74,7 +74,8 @@ With Coverlet you can combine the output of multiple coverage runs into a single dotnet test /p:CollectCoverage=true /p:MergeWith='/path/to/result.json' ``` -The value given to `/p:MergeWith` **must** be a path to Coverlet's own json result format. The results in `result.json` will be read, and added to the new results written to by Coverlet. +The value given to `/p:MergeWith` **must** be a path to Coverlet's own json result format. The results in `result.json` will be read, and added to the new results written to by Coverlet. +[Check the sample](Examples.md). ## Threshold diff --git a/Documentation/VSTestIntegration.md b/Documentation/VSTestIntegration.md index 43a4a79..cd836ab 100644 --- a/Documentation/VSTestIntegration.md +++ b/Documentation/VSTestIntegration.md @@ -30,7 +30,7 @@ These are a list of options that are supported by coverlet. These can be specifi | Option | Summary | |------------- |------------------------------------------------------------------------------------------| |Format | Coverage output format. These are either cobertura, json, lcov, opencover or teamcity as well as combinations of these formats. | -|MergeWith | Combine the output of multiple coverage runs into a single result. | +|MergeWith | Combine the output of multiple coverage runs into a single result([check the sample](Examples.md)). | |Exclude | Exclude from code coverage analysing using filter expressions. | |ExcludeByFile | Ignore specific source files from code coverage. | |Include | Explicitly set what to include in code coverage analysis using filter expressions. |