Skip to content

Commit

Permalink
Update documentation with new feature `InstrumentModulesWithoutLocalS…
Browse files Browse the repository at this point in the history
…ources` (#1385)

Update documentation with new feature `InstrumentModulesWithoutLocalSources`
  • Loading branch information
MarcoRossignoli authored Sep 28, 2022
1 parent e11c14d commit 2b8a456
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
1 change: 1 addition & 0 deletions Documentation/GlobalTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Options:
--merge-with Path to existing coverage result to merge.
--use-source-link Specifies whether to use SourceLink URIs in place of file system paths.
--does-not-return-attribute Attributes that mark methods that do not return.
--instrument-modules-without-local-sources Specifies whether modules should be instrumented even if the sources from the PDBs can't be found locally.
```
NB. For a [multiple value] options you have to specify values multiple times i.e.
Expand Down
4 changes: 4 additions & 0 deletions Documentation/MSBuildIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,10 @@ You can also include coverage of the test assembly itself by setting `/p:Include
Neither track nor record auto-implemented properties.
Syntax: `/p:SkipAutoProps=true`

### Instrument module wihtout local sources file.

This comment has been minimized.

Copy link
@Malivil

Malivil Sep 28, 2022

*without


Syntax: `/p:InstrumentModulesWithoutLocalSources=true`

### Methods that do not return

Methods that do not return can be marked with attributes to cause statements after them to be excluded from coverage.
Expand Down
4 changes: 3 additions & 1 deletion Documentation/VSTestIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ These are a list of options that are supported by coverlet. These can be specifi
| IncludeTestAssembly | Include coverage of the test assembly. |
| SkipAutoProps | Neither track nor record auto-implemented properties. |
| DoesNotReturnAttribute | Methods marked with these attributes are known not to return, statements following them will be excluded from coverage |
| DeterministicReport | Generates deterministic report in context of deterministic build. Take a look at [documentation](DeterministicBuild.md) for further informations. |
| DeterministicReport | Generates deterministic report in context of deterministic build. Take a look at [documentation](DeterministicBuild.md) for further informations. |
| InstrumentModulesWithoutLocalSources | Specifies whether modules should be instrumented even if the sources from the PDBs can't be found locally. |

How to specify these options via runsettings?

Expand All @@ -119,6 +120,7 @@ How to specify these options via runsettings?
<IncludeTestAssembly>true</IncludeTestAssembly>
<SkipAutoProps>true</SkipAutoProps>
<DeterministicReport>false</DeterministicReport>
<InstrumentModulesWithoutLocalSources>false</InstrumentModulesWithoutLocalSources>
</Configuration>
</DataCollector>
</DataCollectors>
Expand Down

0 comments on commit 2b8a456

Please sign in to comment.