Add warning to discourage disabling shadow renaming (#12594)

open-telemetry · Nov 8, 2024 · 29da88e · 29da88e
1 parent b8c20a3
commit 29da88e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/contributing/debugging.md b/docs/contributing/debugging.md
@@ -64,6 +64,10 @@ builds by adding the following to `~/.gradle/gradle.properties` before building.
 disableShadowRelocate=true
 ```
 
+WARNING: disabling shadow renaming will make some of the tests fail. In some cases it can also make
+tests pass when they really should be failing. Use with caution and be prepared for unexpected
+behavior.
+
 ## Missing GraalVM hints
 
 Enable the GraalVM tracing agent: