add miri chapter in README
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
This commit is contained in:
parent
791c7f6e02
commit
374c034e92
10
README.md
10
README.md
@ -61,3 +61,13 @@ cargo install grcov --locked
|
|||||||
|
|
||||||
After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
|
After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
|
||||||
supply the `--open` flag to open the coverage report in your webbrowser.
|
supply the `--open` flag to open the coverage report in your webbrowser.
|
||||||
|
|
||||||
|
# Miri
|
||||||
|
|
||||||
|
You can run the [`miri`](https://github.com/rust-lang/miri) tool on this library to check for
|
||||||
|
undefined behaviour (UB). This library does not use use any `unsafe` code blocks, but `miri` could
|
||||||
|
still catch UB from used libraries.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo +nightly miri nextest run --all-features
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user