kata-containers/rust-vmm-ci
1
0
Fork 0
mirror of https://github.com/rust-vmm/rust-vmm-ci.git synced 2026-08-05 03:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update readme for coverage changes

Browse Source 
Mention that `crate_features` is now optional, and also update a very
outdated reference to `cargo kcov`

Signed-off-by: Patrick Roy <roypat@amazon.co.uk>
This commit is contained in:
Patrick Roy
2025-03-18 13:55:34 +00:00
parent e94bff4ff5
commit 3ea2d3fb2e
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -44,10 +44,13 @@ The json must have the following fields:
if multiple files are to be skipped, they must be separated with `|`).
It should be used to exclude autogenerated files. If the repository does not
have any autogenerated files, `exclude_path` should be an empty string.
- `crate_features`: `cargo kcov` does not build crate features by default. To
get the coverage report including optional features, these need to be
specified in `crate_features` separated by comma. If the crate does not have
any features, this field should be empty.
Additionally, the following optional fields are available:
- `crate_features`: By default, we pass `--all-features` to cargo when collecting
coverage. To have the coverage report only include a subset of features (in addition
to default features, which are always enabled), specify them in this field
as a comma-separated string.
This file is required for the coverage integration so it needs to be added
to the repository as well.