Update README with Kani proofs #356
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MatiasVara
requested review from
alexandruag,
andreeaflorescu,
jiangliu,
slp,
stsquad,
epilys and
stefano-garzarella
as code owners
Update README with existing Kani proofs. Signed-off-by: Matias Ezequiel Vara Larsen <[email protected]>
epilys
force-pushed
the
update_readme_with_kani
branch
from
443f5a9 to
6f4a290
Compare
Comment on lines
+115
to
+117
| conformance proofs: | ||
|
|
||
| * Conformance to 2.7.7.2 section |
There was a problem hiding this comment.
I'm not sure it's a good idea to keep a list of proofs, just because I'm pretty sure we will forget to update xD.
There was a problem hiding this comment.
Also it's not immediately obvious what "2.7.7.2 section" refers to- even with a link to the specification it is still incomplete information. I suggest adding a link to the Rust module maybe?
| conformance proofs: | ||
|
|
||
| * Conformance to 2.7.7.2 section | ||
|
|
There was a problem hiding this comment.
What about adding instructions on how to run it locally?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of the PR
Update README with existing Kani proofs. This PR is regarding the addition of the first proof at #338. I am not sure if the README shall mention the existing PRs because that will force people to keep it update. At the same time, it may be useful for users to know which requirements from the specification are proved to be conform to.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commit message has max 60 characters for thesummary and max 75 characters for each description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafecode is properly documented.