[DOC] warn against explain ALL in production

[nvliyuan]

No issue; documentation clarification requested after a production workload generated enough spark.rapids.sql.explain=ALL diagnostics to make the driver unresponsive.

Description

Clarifies that spark.rapids.sql.explain=ALL is intended only for debugging and must not be enabled for production workloads because it can generate substantial driver log output.

Changes include:

• Update the canonical RapidsConf help text to warn about driver performance and responsiveness risks.
• Recommend the default NOT_ON_GPU level, or NONE, for production workloads.
• Apply the same warning to the supported-operations guidance, which previously recommended ALL without a production caveat.
• Synchronize the generated docs/configs.md and docs/supported_ops.md output with their Scala sources.

Validation:

• git diff --check
• IDE lints on all four modified files
• Verified modified Scala source lines remain within the project line-length limit
• Verified both generated documentation pages contain the corresponding production warning
• Local Maven validation was not available because this machine has no Java runtime; GitHub CI will run compilation, Scalastyle, and generated-doc checks

Checklists

Documentation

• Updated for new or modified user-facing features or behaviors
• No user-facing change

Testing

• Added or modified tests to cover new code paths
• Covered by existing tests
  (Please provide the names of the existing tests in the PR description.)
• Not required

Performance

• Tests ran and results are added in the PR description
• Issue filed with a link in the PR description
• Not required: this changes only static help text and generated documentation; configuration parsing and runtime behavior are unchanged

[greptile-apps]

Greptile Summary

Updates the spark.rapids.sql.explain documentation to warn that ALL is debugging-only and can make production drivers unresponsive.

• Recommends NOT_ON_GPU or NONE for production workloads.
• Synchronizes the generated configuration and supported-operations pages with their Scala sources.

Confidence Score: 5/5

The PR appears safe to merge because it consistently updates static guidance without changing configuration defaults, parsing, or runtime behavior.

The Scala documentation sources and checked-in generated pages are synchronized, and no actionable failure remains.

Important Files Changed

Filename	Overview
sql-plugin/src/main/scala/com/nvidia/spark/rapids/RapidsConf.scala	Extends the canonical EXPLAIN configuration help text with a production warning while preserving its default and runtime behavior.
sql-plugin/src/main/scala/com/nvidia/spark/rapids/TypeChecks.scala	Updates the supported-operations documentation generator with matching guidance for production workloads.
docs/configs.md	Synchronizes the generated configuration entry exactly with the updated RapidsConf help text.
docs/supported_ops.md	Synchronizes the generated supported-operations guidance exactly with its Scala generator.

_{Reviews (1): Last reviewed commit: "[DOC] warn against explain ALL in produc..." | Re-trigger Greptile}

[sameerz]

build

[nvliyuan]

build

[sameerz]

build