Skip to content

Update developer docs after custom sysroot#1729

Merged
celinval merged 2 commits into
model-checking:mainfrom
celinval:issue-1605-docs
Sep 29, 2022
Merged

Update developer docs after custom sysroot#1729
celinval merged 2 commits into
model-checking:mainfrom
celinval:issue-1605-docs

Conversation

@celinval

Copy link
Copy Markdown
Contributor

Description of changes:

After #1717 was merged, users need to run cargo build-dev to build Kani binaries and the sysroot. Update the docs to reflect that change.

Resolved issues:

N/A

Related RFC:

N/A

Call-outs:

Testing:

  • How is this change tested? Build docs

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

After model-checking#1717 was merged, users need to run `cargo build-dev` to build
Kani binaries and the sysroot.
@celinval celinval requested a review from a team as a code owner September 29, 2022 19:12

@adpaco adpaco left a comment

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.

Thanks!

Comment thread docs/src/cheat-sheets.md Outdated
cargo clean -p kani-compiler
cargo build -p kani-compiler
# or similar error? Uncomment the line below and to clean all build artifacts.
# cargo clean

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.

I would uncomment the clean command here.

@celinval celinval merged commit 35b4b10 into model-checking:main Sep 29, 2022
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