Skip to content

Commit

Permalink
[SPARK-44718][FOLLOWUP][DOCS] Avoid using ConfigEntry in spark.sql.co…
Browse files Browse the repository at this point in the history
…lumnVector.offheap.enabled's doc field

### What changes were proposed in this pull request?

Followup of #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).
     - <value of spark.memory.offHeap.enabled>
     - 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 <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
  • Loading branch information
yaooqinn committed Jul 2, 2024
1 parent 5ac7c9b commit 9304223
Showing 1 changed file with 1 addition and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit 9304223

Please sign in to comment.