Skip to content

Update installation guide to include rmc lib build#604

Merged
celinval merged 4 commits intomodel-checking:mainfrom
celinval:fix-doc
Nov 2, 2021
Merged

Update installation guide to include rmc lib build#604
celinval merged 4 commits intomodel-checking:mainfrom
celinval:fix-doc

Conversation

@celinval
Copy link
Copy Markdown
Contributor

Description of changes:

On #597 we introduced an RMC crate. This change is to update the document to reflect the steps needed to build this crate.

Resolved issues:

Call-outs:

Testing:

  • How is this change tested?

  • Is this a refactor change?

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.

@zhassan-aws
Copy link
Copy Markdown
Contributor

@celinval
Copy link
Copy Markdown
Contributor Author

celinval commented Nov 1, 2021

Do you plan on updating the rest of the documentation (e.g. https://github.com/model-checking/rmc/blob/main/rmc-docs/src/dev-documentation.md and https://github.com/model-checking/rmc/blob/main/rmc-docs/src/tutorial-first-steps.md) in a separate PR?

I can add this to the dev-documentation.md. And I'll replace __nondet and __VERIFIER_assume too. Let me update this.

}

fn __nondet() -> u32 {
fn rmc::nondet() -> u32 {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You probably meant to remove this function.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yep... thanks for catching it.

Forgot to remove one nondet definition.
([`--keep-stage` comes with caveats](https://rustc-dev-guide.rust-lang.org/building/suggested.html#incremental-builds-with---keep-stage). Know that it may cause spurious build failures.)
```bash
# Build rmc crate
./scripts/setup/rmc_build_lib.sh
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we make this part of x.py in the rmc case?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I debated about this one. I wanted to start untangling ourselves from the bootstrap script. My goal is to actually enhance this script to also compile an RMC friendly std library.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'll merge as is since this is documenting what's been pushed already. If you prefer I can modify the bootstrap script to build the RMC library and I can update this doc again. Just let me know and I can create a follow up PR.

@celinval celinval merged commit 9d495b4 into model-checking:main Nov 2, 2021
@celinval celinval deleted the fix-doc branch November 2, 2021 15:56
tedinski pushed a commit to tedinski/rmc that referenced this pull request Apr 26, 2022
tedinski pushed a commit that referenced this pull request Apr 27, 2022
Update documentation after adding rmc crate
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.

3 participants