Skip to content

Commit 878e5b9

Browse files
authored
README.md & getting-started.md (model-checking#2287)
1 parent 5195423 commit 878e5b9

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
The Kani Rust Verifier is a bit-precise model checker for Rust.
66

7-
Kani is particularly useful for verifying unsafe code in Rust, where many of the language's usual guarantees are no longer checked by the compiler.
7+
Kani is particularly useful for verifying unsafe code blocks in Rust, where the "[unsafe superpowers](https://doc.rust-lang.org/stable/book/ch19-01-unsafe-rust.html#unsafe-superpowers)" are unchecked by the compiler.
8+
___
89
Kani verifies:
910
* Memory safety (e.g., null pointer dereferences)
1011
* User-specified assertions (i.e., `assert!(...)`)

docs/src/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Getting started
22

33
Kani is an open-source verification tool that uses [model checking](./tool-comparison.md) to analyze Rust programs.
4-
Kani is particularly useful for verifying unsafe code in Rust, where many of the Rust’s usual guarantees are no longer checked by the compiler.
4+
Kani is particularly useful for verifying unsafe code blocks in Rust, where the "[unsafe superpowers](https://doc.rust-lang.org/stable/book/ch19-01-unsafe-rust.html#unsafe-superpowers)" are unchecked by the compiler.
55
Some example properties you can prove with Kani include memory safety properties (e.g., null pointer dereferences, use-after-free, etc.), the absence of certain runtime errors (i.e., index out of bounds, panics), and the absence of some types of unexpected behavior (e.g., arithmetic overflows).
66
Kani can also prove custom properties provided in the form of user-specified assertions.
77
As Kani uses model checking, Kani will either prove the property, disprove the

0 commit comments

Comments
 (0)