Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-44718][FOLLOWUP][DOCS] Avoid using ConfigEntry in spark.sql.columnVector.offheap.enabled's doc field #47165

Closed
wants to merge 1 commit into from

Conversation

yaooqinn
Copy link
Member

@yaooqinn yaooqinn commented Jul 1, 2024

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

@github-actions github-actions bot added the SQL label Jul 1, 2024
@yaooqinn
Copy link
Member Author

yaooqinn commented Jul 1, 2024

@cloud-fan @mojodna @HyukjinKwon thanks

@yaooqinn yaooqinn changed the title [SPARK-44718][SQL][DOCS] Avoid using ConfigEntry in spark.sql.columnVector.offheap.enabled's doc field [SPARK-44718][FOLLOWUP][DOCS] Avoid using ConfigEntry in spark.sql.columnVector.offheap.enabled's doc field Jul 1, 2024
@yaooqinn
Copy link
Member Author

yaooqinn commented Jul 2, 2024

Merged to master, thank you @allisonwang-db @dongjoon-hyun @HyukjinKwon

@yaooqinn yaooqinn closed this in 9304223 Jul 2, 2024
attilapiros pushed a commit to attilapiros/spark that referenced this pull request Oct 4, 2024
…lumnVector.offheap.enabled's doc field

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

Followup of apache#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 apache#47165 from yaooqinn/minor2.

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: Kent Yao <yao@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants