Skip to content

Commit

Permalink
Complete default behavior for Kani coverage workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
adpaco-aws committed Aug 23, 2024
1 parent 1f49b1d commit 5ed66ed
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion rfc/src/rfcs/0011-source-coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,10 @@ uses the JSON format but we might consider using a binary format if it doesn't
scale.

In addition, Kani will produce two types of coverage results:
1. A coverage summary
1. A coverage summary with the default options.
2. A terminal-based coverage report with the default options. However, we will
only do this if the program is composed of a single source
file[^note-conditional-report].

[^note-kanimap]: Note that the `.kanimap` generation isn't implemented in
[#3119](https://github.com/model-checking/kani/pull/3119). The [draft
Expand All @@ -517,6 +520,10 @@ In addition, Kani will produce two types of coverage results:
the source files referred to by the code coverage checks, but it doesn't get
information about code trimmed out by the MIR linker.

[^note-conditional-report]: In other words, standalone `kani` would always emit
these terminal-based reports, but `cargo kani` would not unless the project
contains a single Rust file (for example, `src/main.rs`).

## Rationale and alternatives

### Other coverage implementations
Expand Down

0 comments on commit 5ed66ed

Please sign in to comment.