Skip to content

Commit

Permalink
Note presence of Proof README and Proof Guide and add links to these …
Browse files Browse the repository at this point in the history
…documents.

Signed-off-by: Rod Chapman <[email protected]>
  • Loading branch information
rod-chapman committed Oct 17, 2024
1 parent f2c85b3 commit 7fc1030
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions cbmc/proofs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ of certain classes of undefined behaviour for parts of the C-code in MLKEM-C-AAr
Proofs are organized by functions, with the harnesses and proofs for each function
in a separate directory.

TODO: Provide more information about CBMC and the properties it proves
See the [Proof Guide](proof_guide.md) for a walkthrough of how to use CBMC and
develop new proofs.

# Usage

Expand All @@ -26,6 +27,10 @@ If `GITHUB_STEP_SUMMARY` is set, the proof summary will be appended to it.

# Covered functions

The following functions are currently covered:
Each proved function has a eponymous sub-directory of its own. The shell command

- `poly.c`: `poly_compress`
```
find . -name cbmc-proof.txt
```

yields a list of the subdirectories, and thus function names, that have a proof.

0 comments on commit 7fc1030

Please sign in to comment.