diff --git a/README.md b/README.md index a289bee..a267f82 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,11 @@ found in The json must have the following fields: - `coverage_score`: The coverage of the repository. -- `exclude_path`: This field is used for excluding files from the report. It - should be used to exclude autogenerated files. Files in `exclude_path` are - separated by one comma. If the repository does not have any autogenerated - files, `exclude_path` should be an empty string. +- `exclude_path`: This field is used for excluding files from the report. + File paths that match the given regular expression are skipped. (for example, + 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 diff --git a/coverage_config_aarch64.json.sample b/coverage_config_aarch64.json.sample index 60dcb24..1f45330 100644 --- a/coverage_config_aarch64.json.sample +++ b/coverage_config_aarch64.json.sample @@ -1,5 +1,5 @@ { "coverage_score": 90, - "exclude_path": "my_autogenerated_file.rs,second_file.rs", + "exclude_path": "my_autogenerated_file\\.rs|path/to/my_folder", "crate_features": "my_dummy_feature,dummy_feature2" } diff --git a/coverage_config_x86_64.json.sample b/coverage_config_x86_64.json.sample index 60dcb24..1f45330 100644 --- a/coverage_config_x86_64.json.sample +++ b/coverage_config_x86_64.json.sample @@ -1,5 +1,5 @@ { "coverage_score": 90, - "exclude_path": "my_autogenerated_file.rs,second_file.rs", + "exclude_path": "my_autogenerated_file\\.rs|path/to/my_folder", "crate_features": "my_dummy_feature,dummy_feature2" }