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

[docs] Add documentation for cache configuration properties #24623

Merged

Conversation

minhancao
Copy link
Contributor

@minhancao minhancao commented Feb 24, 2025

Description

Add documentation for cache configuration properties

All of these cache configuration properties are defined here in the codebase:
https://github.com/prestodb/presto/blob/master/presto-native-execution/presto_cpp/main/common/Configs.h#L328

Relates to facebookincubator/velox#11429

Motivation and Context

Impact

Test Plan

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== RELEASE NOTES ==

Documentation
* Add documentation for cache configuration properties

@minhancao minhancao self-assigned this Feb 24, 2025
@minhancao minhancao requested review from steveburnett, elharo and a team as code owners February 24, 2025 23:41
@minhancao minhancao requested a review from presto-oss February 24, 2025 23:41
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Feb 24, 2025
@prestodb-ci prestodb-ci requested review from a team and anandamideShakyan and removed request for a team February 24, 2025 23:41
@github-actions github-actions bot added the docs label Feb 24, 2025
@minhancao minhancao force-pushed the cache_configs_doc_prestissimo branch from 2427fdf to 3d22475 Compare February 24, 2025 23:44
Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the doc! Some formatting issues and some nits of phrasing suggestions. Looks good overall!

Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the doc update, this looks much better! A few nits of formatting,

@minhancao minhancao force-pushed the cache_configs_doc_prestissimo branch 2 times, most recently from 569293a to 45286ac Compare March 3, 2025 19:29
Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update! One final nit.

@minhancao minhancao force-pushed the cache_configs_doc_prestissimo branch from 45286ac to 6bdc3ae Compare March 3, 2025 20:05
Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! (docs)

Pull updated branch, new local doc build, looks good. Thanks!

@steveburnett steveburnett merged commit bd01f3d into prestodb:master Mar 3, 2025
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs from:IBM PR from IBM
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants