Skip to content

Add docs section for debugging for contributors #24946

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kumarUjjawal merged 3 commits into from
Sep 6, 2026
+14 −0
Merged

Add docs section for debugging for contributors #24946

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d66f9a
Add docs section for debugging for contributors
mkleen Sep 4, 2026
8eaaac9
Merge branch 'main' into debugging-docs
mkleen Sep 4, 2026
cf8d799
Merge branch 'main' into debugging-docs
mkleen Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/source/contributor-guide/development_environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,17 @@ Formatting instructions:
or run them all at once:

- [dev/rust_lint.sh](../../../dev/rust_lint.sh)

Debugging:

The standard dev profile, used by cargo build and cargo test, disables variable-level DWARF debug information that is required by interactive debuggers.

If you need to step through the code with a debugger, build with:

`CARGO_PROFILE_DEV_DEBUG=2 cargo build`

Alternatively, you can set `CARGO_PROFILE_DEV_DEBUG=2` as an environment variable in your IDE.

This enables the additional debug information required for source-level debugging.

For more details, see the DataFusion [Cargo.toml](https://github.com/apache/datafusion/blob/main/Cargo.toml#L329) configuration.