docs: add DWARF-absent heuristic fallback and --mock flag coverage#1033
Merged
Timi16 merged 1 commit intoApr 27, 2026
Merged
Conversation
…erage Resolves two documentation gaps identified in the backlog: - source-level-debugging.md: adds a dedicated "When DWARF Is Absent: Heuristic Fallback" section explaining the heuristic function-level mapping mode, the HEURISTIC_NO_DWARF reason code, breakpoint response fields, how to compile with debug symbols, and how to diagnose fallback mode via the inspect command. Complements the existing FAQ entry. - debug-cross-contract.md: adds section 8 "Isolating Cross-Contract Calls with --mock" covering the --mock flag syntax, a worked example, multi-callee mocking, the mock call log, the VS Code launch.json config, and guidance on when to use the flag. References mock-helpers.md for advanced patterns. Renumbers the subsequent sections accordingly. closes Timi16#948 closes Timi16#949
|
@Elizabethxxx Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Summary
docs/source-level-debugging.md: Adds a dedicated "When DWARF Is Absent: Heuristic Fallback" section that explains what the debugger does when DWARF debug info is missing from a binary — heuristic function-level mapping, theHEURISTIC_NO_DWARFreason code, breakpoint response fields (verified,reasonCode,setBreakpoint), how to compile with debug symbols, and how to useinspectto diagnose fallback mode. This brings the reference doc in line with the existing FAQ entry on the same topic.docs/debug-cross-contract.md: Adds section 8 "Isolating Cross-Contract Calls with--mock" covering the flag syntax, a worked example mockingCalleeContract::increment, multi-callee mocking, the mock call log output, the VS Codelaunch.jsonconfiguration, and guidance on when to reach for this flag. Referencesmock-helpers.mdfor advanced patterns. Subsequent sections renumbered accordingly.Test plan
docs/source-level-debugging.md— new section appears after Requirements & Implementation, cross-links tosource-map-health.mdandfaq.mdare valid.docs/debug-cross-contract.md— new section 8 appears between Key Takeaways and Git Workflow, examples match the--mock CONTRACT_ID.function=valueformat documented insrc/cli/args.rsand exercised intests/cli/output_tests.rs.debug-cross-contract.mdin a way that is now broken.closes #948
closes #949