Skip to content
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

Add #[kani::unstable] attribute #2373

Merged
merged 3 commits into from
Apr 14, 2023

Conversation

celinval
Copy link
Contributor

@celinval celinval commented Apr 13, 2023

Description of changes:

Add the #[unstable] attribute that will allow us to mark unstable APIs. This PR only adds the attributes and we still need to add the option to enable them and to error out if the user is trying to use an unstable item without explicitly opting-in.

Resolved issues:

Related to #2279

Related RFC:

#2281

Call-outs:

This PR is not yet enforcing the correct format which will follow the one described in the RFC:

#[kani::unstable(feature="<IDENTIFIER>", issue="<TRACKING_ISSUE_NUMBER>", reason="<OPTIONAL_DESCRIPTION>")]
pub fn unstable_api() {}

Testing:

  • How is this change tested? Manually tested

  • Is this a refactor change? No

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@celinval celinval requested a review from a team as a code owner April 13, 2023 23:55
@jaisnan
Copy link
Contributor

jaisnan commented Apr 14, 2023

Could you add an example of what the usage of this attribute might look like in the description?

@celinval
Copy link
Contributor Author

celinval commented Apr 14, 2023

@jaisnan right now this PR is not enforcing anything, including format. I'll add that to my follow up PR. I did ask the format in the description as requested.

@celinval celinval enabled auto-merge (squash) April 14, 2023 17:12
@celinval celinval merged commit c4ed7ec into model-checking:main Apr 14, 2023
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.

4 participants