Skip to content

Commit 9b0cfe2

Browse files
committed
doc: update readme for coverage changes
Mention that `crate_features` is now optional, and also update a very outdated reference to `cargo kcov` Signed-off-by: Patrick Roy <[email protected]>
1 parent e184399 commit 9b0cfe2

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,13 @@ The json must have the following fields:
4444
if multiple files are to be skipped, they must be separated with `|`).
4545
It should be used to exclude autogenerated files. If the repository does not
4646
have any autogenerated files, `exclude_path` should be an empty string.
47-
- `crate_features`: `cargo kcov` does not build crate features by default. To
48-
get the coverage report including optional features, these need to be
49-
specified in `crate_features` separated by comma. If the crate does not have
50-
any features, this field should be empty.
47+
48+
Additionally, the following optional fields are available:
49+
50+
- `crate_features`: By default, we pass `--all-features` to cargo when collecting
51+
coverage. To have the coverage report only include a subset of features (in addition
52+
to default features, which are always enabled), specify them in this field
53+
as a comma-separated string.
5154

5255
This file is required for the coverage integration so it needs to be added
5356
to the repository as well.

0 commit comments

Comments
 (0)