Skip to content

Commit

Permalink
New section about linter configuraton checking in the doc. (#3198)
Browse files Browse the repository at this point in the history
Resolves #3197 

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 and MIT licenses.

Co-authored-by: Remi Delmas <delmasrd@amazon.com>
  • Loading branch information
remi-delmas-3000 and Remi Delmas committed May 22, 2024
1 parent 1ba6cb2 commit 5dc5e0b
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/src/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ default-unwind = 1

The options here are the same as on the command line (`cargo kani --help`), and flags (that is, command line arguments that don't take a value) are enabled by setting them to `true`.

Starting with Rust 1.80 (or nightly-2024-05-05), every reachable #[cfg] will be automatically checked that they match the expected config names and values.
To avoid warnings on `cfg(kani)`, we recommend adding the `check-cfg` lint config in your crate's `Cargo.toml` as follows:

```toml
[lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(kani)'] }
```

For more information please consult this [blog post](https://blog.rust-lang.org/2024/05/06/check-cfg.html).

## The build process

When Kani builds your code, it does two important things:
Expand Down

0 comments on commit 5dc5e0b

Please sign in to comment.