Skip to content

Update README with Kani proofs #356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2025

Conversation

MatiasVara
Copy link
Contributor

@MatiasVara MatiasVara commented Jul 29, 2025

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.

Closes: #353

Requirements

Before submitting your PR, please make sure you addressed the following
requirements:

  • All commits in this PR have Signed-Off-By trailers (with
    git commit -s), and the commit message has max 60 characters for the
    summary and max 75 characters for each description line.
  • All added/changed functionality has a corresponding unit/integration
    test.
  • All added/changed public-facing functionality has entries in the "Upcoming
    Release" section of CHANGELOG.md (if no such section exists, please create one).
  • Any newly added unsafe code is properly documented.

Copy link
Member

@stefano-garzarella stefano-garzarella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for that!

Please add Closes: #353

@MatiasVara MatiasVara force-pushed the update_readme_with_kani branch 2 times, most recently from 85f029a to 4c9a725 Compare July 31, 2025 14:25
@stefano-garzarella
Copy link
Member

@MatiasVara can you also rebase?

Update README with Kani proofs.

Signed-off-by: Matias Ezequiel Vara Larsen <[email protected]>
@MatiasVara MatiasVara force-pushed the update_readme_with_kani branch from 4c9a725 to 45f4ef1 Compare July 31, 2025 18:07
@epilys epilys enabled auto-merge (rebase) July 31, 2025 19:06
@epilys epilys merged commit c7795db into rust-vmm:main Aug 1, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

kani: add a section in the readme
3 participants