(datafusion) branch main updated: Add docs section for debugging for contributors (#24946)

[gi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

github-merge-queue[bot] pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git


The following commit(s) were added to refs/heads/main by this push:
     new 1d9a982b40 Add docs section for debugging for contributors (#24946)
1d9a982b40 is described below

commit 1d9a982b4049725e6727c7cd3724414911dc802b
Author: Michael Kleen <mk...@gmail.com>
AuthorDate: Sun Sep 6 04:49:38 2026 +0000

    Add docs section for debugging for contributors (#24946)
    
    ## Which issue does this PR close?
    
    
    
    - Closes None
    
    ## Rationale for this change
    
    Since https://github.com/apache/datafusion/pull/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.
---
 docs/source/contributor-guide/development_environment.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/source/contributor-guide/development_environment.md b/docs/source/contributor-guide/development_environment.md
index 2e4e007265..5b6f024b53 100644
--- a/docs/source/contributor-guide/development_environment.md
+++ b/docs/source/contributor-guide/development_environment.md
@@ -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.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org