Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); docs: Correct `default-unwind` Cargo.toml examples by hashcatHitman · Pull Request #4496 · model-checking/kani · GitHub
Skip to content

docs: Correct default-unwind Cargo.toml examples - #4496

Merged
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs
Dec 10, 2025
Merged

docs: Correct default-unwind Cargo.toml examples#4496
zhassan-aws merged 1 commit into
model-checking:mainfrom
hashcatHitman:default-unwind-docs

Conversation

@hashcatHitman

Copy link
Copy Markdown
Contributor

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#4495

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

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>
@hashcatHitman
hashcatHitman requested a review from a team as a code ownerDecember 10, 2025 19:13
@zhassan-aws

Copy link
Copy Markdown
Contributor

Thanks!

@zhassan-aws
zhassan-aws added this pull request to the merge queueDec 10, 2025
Merged via the queue into model-checking:main with commit 21f3a28Dec 10, 2025
33 checks passed
@hashcatHitman
hashcatHitman deleted the default-unwind-docs branch December 10, 2025 21:08
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.
Resolvesmodel-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-queueBot 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 freeto 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.

Docs are misleading about default-unwind configuration

2 participants

@hashcatHitman@zhassan-aws