Skip to content

Improve code contract documentation #5525

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
feliperodri opened this issue Oct 15, 2020 · 1 comment
Closed

Improve code contract documentation #5525

feliperodri opened this issue Oct 15, 2020 · 1 comment
Assignees
Labels
aws Bugs or features of importance to AWS CBMC users Code Contracts Function and loop contracts

Comments

@feliperodri
Copy link
Collaborator

feliperodri commented Oct 15, 2020

CBMC version: > 5.12
Operating system: N/A.
Exact command line resulting in the issue: N/A.
What behaviour did you expect: Complete documentation for current code contract support.
What happened instead:

Currently, CPROVER Manual doesn't have a complete documentation for code contracts (e.g., __CPROVER_ensures, __CPROVER_requires, __CPROVER_assigns, etc.). There should be a section in the manual describing the current support for these features. Particularly, improve the current section for assigns clauses:

  1. The documentation of assigns clause should clarify how CBMC checks that memory not captured by an assigns clause will not be written within a given scope;
  2. Improve explanation in Semantic. Enforcement subsection on how an assigns clause is a sound characterization
    of the behavior of a given function.
@feliperodri feliperodri added the aws Bugs or features of importance to AWS CBMC users label Oct 15, 2020
@feliperodri feliperodri added the Code Contracts Function and loop contracts label Feb 5, 2021
@feliperodri feliperodri self-assigned this Feb 5, 2021
@feliperodri
Copy link
Collaborator Author

#6185 solves this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aws Bugs or features of importance to AWS CBMC users Code Contracts Function and loop contracts
Projects
None yet
Development

No branches or pull requests

1 participant