Skip to content

Notes about KMIR tool application PR feedback #4

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

Closed
9 of 10 tasks
jberthold opened this issue Apr 5, 2025 · 4 comments
Closed
9 of 10 tasks

Notes about KMIR tool application PR feedback #4

jberthold opened this issue Apr 5, 2025 · 4 comments

Comments

@jberthold
Copy link
Member

jberthold commented Apr 5, 2025

Small things

  • Goto transcode -> Goto transcoder (kmir.md "Verification Backend" section)
  • delete "critical" in "critical intermediate representation" (checkbox section)
  • Link to mir-semantics repo on github in checkbox section
  • Should we maintain (and link to) a list of missing features in mir-semantics? (Question in the Checkbox section)
  • Mention docker image as an option in the CI question in the checkbox section

Larger content to add or modify

  • Don't speculate over future kup based things in the doc.s here
  • Document what is in the docker image
  • Say more about K framework in general before explaining how kmir is based on it
  • address detailed questions in Add kmir tool description and CI workflow model-checking/verify-rust-std#310 (comment) by rewording the description after the MIR diagram
  • Explain "how 'symbolic execution' and 'proof' go together" in 1st paragraph:
    • K enables symbolic execution of MIR by rewriting
    • a program property becomes an all-path reachability problem in a rewriting system
    • a proof of reachability proves the property (given the semantics of MIR)
      This should probably be very short in the 1st paragraph but then be expanded in the subsequent section about K and kmir below.
@jberthold
Copy link
Member Author

Branch add-kmir-tool-version2 for edits, to be copied over when ready

@jberthold
Copy link
Member Author

I removed kontrol and evm-semantics from the links section and renamed it "Background Reading". Maybe we can remove this section in favour of a longer description of K Framework in the earlier part.

@jberthold
Copy link
Member Author

More radical suggestions to modify the kmir.md description:

  • Remove "Versioning" entirely
  • Largely modify the "CI" section to only describe tool usage and how to find/install it, and move this into "Steps to Use the Tool
  • Make "Licenses" a paragraph in the first section (removing its heading)

We could post this on the PR as a suggestion, asking whether we should do it.

@jberthold
Copy link
Member Author

Edits done as described

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

No branches or pull requests

1 participant