From b9e7943131926fa7c89bc2e61fbcaff016a6409a Mon Sep 17 00:00:00 2001 From: Jaisurya Nanduri Date: Fri, 20 Sep 2024 20:06:17 +0000 Subject: [PATCH] Add link to https://github.com/model-checking/verify-rust-std --- doc/src/tools/kani.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/tools/kani.md b/doc/src/tools/kani.md index 4e03766c519d6..85dc859698f93 100644 --- a/doc/src/tools/kani.md +++ b/doc/src/tools/kani.md @@ -55,8 +55,7 @@ Here is a short tutorial to get started with using Kani to verify some proofs th ### Step 1 - Add some proofs to your copy of the model-checking std -Create a local copy of the model-checking fork of the Rust Standard Library. The fork comes with Kani initiated, so all you'll need to do is to call Kani's -building-block APIs (such as +Create a local copy of the [model-checking fork](https://github.com/model-checking/verify-rust-std) of the Rust Standard Library. The fork comes with Kani configured, so all you'll need to do is to call Kani's building-block APIs (such as `assert`, `assume`, `proof` and [function-contracts](https://github.com/model-checking/kani/blob/main/rfc/src/rfcs/0009-function-contracts.md) such as `modifies`, `requires` and `ensures`) directly. For example, insert this module into an existing file in the core library, like `library/core/src/hint.rs` or `library/core/src/error.rs` in your copy of the library. This is just for the purpose of getting started, so you can insert in any existing file in the core library if you have other preferences. @@ -120,6 +119,7 @@ Complete - 2 successfully verified harnesses, 0 failures, 2 total. You can specify a specific harness to be verified using the `--harness` flag. For example, in your local copy of the verify repo, run the following command. + ``` kani verify-std --harness harness_introduction -Z unstable-options "./library" --target-dir "/tmp" -Z function-contracts -Z mem-predicates ```