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

Documentation: Updates for "Usage - On a single file" #978

Merged
merged 2 commits into from
Mar 28, 2022

Conversation

adpaco-aws
Copy link
Contributor

Description of changes:

Removes the CBMC arguments section because we plan on keeping the flag hidden. Sets the "common arguments" to --function, --unwind, --output-format and --visualize, which nowadays are the most common ones.

Feel free to share your opinion.

Resolved issues:

Part of #700

Call-outs:

Testing:

  • How is this change tested? N/A

  • 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.

@adpaco-aws adpaco-aws requested a review from a team as a code owner March 24, 2022 20:31
Copy link
Contributor

@tedinski tedinski left a comment

Choose a reason for hiding this comment

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

I think it looks good. It needs updating to handle --harness instead of --function now though.

@adpaco-aws
Copy link
Contributor Author

@tedinski updated to replace "function" by "harness", and tweaked a few things to account for what is now the default behavior (i.e., run all proof harnesses). Can you take another look?

@adpaco-aws adpaco-aws merged commit 7015212 into model-checking:main Mar 28, 2022
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 22, 2022
…#978)

* Documentation: Usage (on a single file)

* Add `--` to `output-format`
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 25, 2022
…#978)

* Documentation: Usage (on a single file)

* Add `--` to `output-format`
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
…#978)

* Documentation: Usage (on a single file)

* Add `--` to `output-format`
tedinski pushed a commit that referenced this pull request Apr 27, 2022
* Documentation: Usage (on a single file)

* Add `--` to `output-format`
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.

2 participants