docs: Correct default-unwind Cargo.toml examples
#4496
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The examples for configuring `default-unwind` inside Cargo.toml files use unquoted integers. This isn't how they are actually expected to be written, and following these examples leads to kani failing to run. This corrects the examples in the documentation to align with the expected configuration format. Signed-off-by: hashcatHitman <155700084+hashcatHitman@users.noreply.github.com>
Contributor
|
Thanks! |
zhassan-aws
approved these changes
Dec 10, 2025
zhassan-aws
pushed a commit
to tautschnig/kani
that referenced
this pull request
Jan 14, 2026
The examples for configuring `default-unwind` inside Cargo.toml files use unquoted integers. This isn't how they are actually expected to be written, and following these examples leads to kani failing to run. This corrects the examples in the documentation to align with the expected configuration format. Resolves model-checking#4495 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses. Signed-off-by: hashcatHitman <155700084+hashcatHitman@users.noreply.github.com>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 15, 2026
0.67.0 Kani release Raw release notes: ``` ## What's Changed * Upgrade Rust toolchain to 2025-11-06 by @tautschnig in #4451 * Upgrade Rust toolchain to 2025-11-07 by @tautschnig in #4454 * Automatic toolchain upgrade to nightly-2025-11-08 by @github-actions[bot] in #4456 * Automatic toolchain upgrade to nightly-2025-11-09 by @github-actions[bot] in #4457 * Automatic cargo update to 2025-11-10 by @github-actions[bot] in #4459 * Gracefully fail when compiling structs with too large array by @tautschnig in #4461 * Upgrade Rust toolchain to 2025-11-10 by @tautschnig in #4460 * Bump tests/perf/s2n-quic from `e726f08` to `cf77e2b` by @dependabot[bot] in #4462 * Automatic toolchain upgrade to nightly-2025-11-11 by @github-actions[bot] in #4463 * fix: Make kani attribute nameres work with generic args having `::` by @ShoyuVanilla in #4427 * NixOS: patch binaries if the dynamic linker is a stub by @GrigorenkoPV in #4413 * Update charon submodule by 15 commits by @tautschnig in #4464 * Arrays with more than 64 elements no longer cause spurious failures by @tautschnig in #4470 * Upgrade Rust toolchain to 2025-11-12 by @tautschnig in #4469 * Upgrade Rust toolchain to 2025-11-13 by @tautschnig in #4473 * Automatic cargo update to 2025-11-17 by @github-actions[bot] in #4476 * Upgrade Rust toolchain to 2025-11-16 by @tautschnig in #4477 * Automatic toolchain upgrade to nightly-2025-11-18 by @github-actions[bot] in #4478 * Upgrade Rust toolchain to 2025-11-19 by @tautschnig in #4482 * Automatic toolchain upgrade to nightly-2025-11-20 by @github-actions[bot] in #4483 * Automatic cargo update to 2025-11-24 by @github-actions[bot] in #4487 * Bump tests/perf/s2n-quic from `cf77e2b` to `25d7f4e` by @dependabot[bot] in #4489 * Bump actions/checkout from 5 to 6 by @dependabot[bot] in #4488 * Automatic cargo update to 2025-12-01 by @github-actions[bot] in #4491 * Bump tests/perf/s2n-quic from `25d7f4e` to `77f104c` by @dependabot[bot] in #4492 * Automatic cargo update to 2025-12-08 by @github-actions[bot] in #4493 * Bump tests/perf/s2n-quic from `77f104c` to `1ac1364` by @dependabot[bot] in #4494 * docs: Correct `default-unwind` Cargo.toml examples by @hashcatHitman in #4496 * Automatic cargo update to 2025-12-15 by @github-actions[bot] in #4497 * Bump peter-evans/create-pull-request from 7 to 8 by @dependabot[bot] in #4498 * Bump actions/download-artifact from 6 to 7 by @dependabot[bot] in #4499 * Bump tests/perf/s2n-quic from `1ac1364` to `8445d10` by @dependabot[bot] in #4500 * Bump mdbook version by @zhassan-aws in #4503 * Bump tests/perf/s2n-quic from `8445d10` to `112439c` by @dependabot[bot] in #4502 * Automatic cargo update to 2025-12-22 by @github-actions[bot] in #4501 * Bump tests/perf/s2n-quic from `112439c` to `dce0a3c` by @dependabot[bot] in #4506 * Automatic cargo update to 2025-12-29 by @github-actions[bot] in #4505 * Automatic cargo update to 2026-01-05 by @github-actions[bot] in #4508 * Add a section with recommended setup for Rust Analyzer by @zhassan-aws in #4504 * Automatic cargo update to 2026-01-12 by @github-actions[bot] in #4509 * Bump tests/perf/s2n-quic from `dce0a3c` to `058783f` by @dependabot[bot] in #4510 * Upgrade Rust toolchain to 2025-11-21 by @tautschnig in #4486 ## New Contributors * @hashcatHitman made their first contribution in #4496 **Full Changelog**: kani-0.66.0...kani-0.67.0 ``` By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses. --------- Co-authored-by: Michael Tautschnig <mt@debian.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The examples for configuring
default-unwindinside Cargo.toml files use unquoted integers. This isn't how they are actually expected to be written, and following these examples leads to kani failing to run.This corrects the examples in the documentation to align with the expected configuration format.
Resolves #4495
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.