Skip to content

Commit 1d9a982

Browse files
authored
Add docs section for debugging for contributors (apache#24946)
## Which issue does this PR close? - Closes None ## Rationale for this change Since apache#24339, the debugging behavior has changed, and variables are no longer included in the debugging output by default. This PR adds a section to the contributor documentation explaining how to enable variable output during debugging. ## What changes are included in this PR? See above. ## What is the testing strategy for this PR? Only doc changes. ## Are there any user-facing changes? No.
1 parent 4f7ce26 commit 1d9a982

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎docs/source/contributor-guide/development_environment.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,17 @@ Formatting instructions:
130130
or run them all at once:
131131

132132
- [dev/rust_lint.sh](../../../dev/rust_lint.sh)
133+
134+
Debugging:
135+
136+
The standard dev profile, used by cargo build and cargo test, disables variable-level DWARF debug information that is required by interactive debuggers.
137+
138+
If you need to step through the code with a debugger, build with:
139+
140+
`CARGO_PROFILE_DEV_DEBUG=2 cargo build`
141+
142+
Alternatively, you can set `CARGO_PROFILE_DEV_DEBUG=2` as an environment variable in your IDE.
143+
144+
This enables the additional debug information required for source-level debugging.
145+
146+
For more details, see the DataFusion [Cargo.toml](https://github.com/apache/datafusion/blob/main/Cargo.toml#L329) configuration.

0 commit comments

Comments
 (0)