From 930422389352b8349e5a845c8cae9993d30dce17 Mon Sep 17 00:00:00 2001 From: Kent Yao Date: Tue, 2 Jul 2024 09:53:44 +0800 Subject: [PATCH] [SPARK-44718][FOLLOWUP][DOCS] Avoid using ConfigEntry in spark.sql.columnVector.offheap.enabled's doc field ### What changes were proposed in this pull request? Followup of https://github.com/apache/spark/pull/42394 ``` * - spark.sql.columnVector.offheap.enabled - When true, use OffHeapColumnVector in ColumnarBatch. Defaults to ConfigEntry(key=spark.memory.offHeap.enabled, defaultValue=false, doc=If true, Spark will attempt to use off-heap memory for certain operations. If off-heap memory use is enabled, then spark.memory.offHeap.size must be positive., public=true, version=1.6.0). - - 2.3.0 ``` The doc field shall be interpolated by MEMORY_OFFHEAP_ENABLED.key instead of MEMORY_OFFHEAP_ENABLED. In this PR, we remove the doc redundant doc as it's also can be found in the `MEMORY_OFFHEAP_ENABLED.defaultValueString` ### Why are the changes needed? docfix ### Does this PR introduce _any_ user-facing change? no ### How was this patch tested? manually debugging ### Was this patch authored or co-authored using generative AI tooling? no Closes #47165 from yaooqinn/minor2. Authored-by: Kent Yao Signed-off-by: Kent Yao --- .../src/main/scala/org/apache/spark/sql/internal/SQLConf.scala | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala index 3b6374e712c66..15275be00f31e 100644 --- a/sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala +++ b/sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala @@ -535,8 +535,7 @@ object SQLConf { val COLUMN_VECTOR_OFFHEAP_ENABLED = buildConf("spark.sql.columnVector.offheap.enabled") .internal() - .doc("When true, use OffHeapColumnVector in ColumnarBatch. " + - s"Defaults to $MEMORY_OFFHEAP_ENABLED.") + .doc("When true, use OffHeapColumnVector in ColumnarBatch.") .version("2.3.0") .fallbackConf(MEMORY_OFFHEAP_ENABLED)