dchristle opened a new pull request, #21729:
URL: https://github.com/apache/flink/pull/21729
<!--
*Thank you very much for contributing to Apache Flink - we are happy that
you want to help us improve Flink. To help the community review your
contribution in the best possible way, please go through the checklist below,
which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a
hassle. In order to uphold a high standard of quality for code contributions,
while at the same time managing a large number of contributions, we need
contributors to prepare the contributions well, and give reviewers enough
contextual information for the review. Please also understand that
contributions that do not follow this guide will take longer to review and thus
typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA
issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are
made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the
pull request", where *FLINK-XXXX* should be replaced by the actual issue
number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following
this pattern: `[hotfix] [docs] Fix typo in event time introduction` or
`[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes. You can set up Azure Pipelines CI to do that following [this
guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
(including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
This PR corrects and improves the readability of the documentation for
RocksDB predefined option sets. References to `disableDataSync`, which is not
set and has been removed from RocksDB for some time, are removed. I also sorted
the options lexicographically, and did the same for the code that sets these
options. This makes it easier to read & spot bugs. While doing this, I noticed
the `SPINNING_DISK_OPTIMIZED_HIGH_MEM` predefined option set actually enables
Bloom filter usage, but it isn't documented to do that. I added brief
documentation for it. There are some other minor inconsistencies in the Python
vs Java documentation that I tried to match up, too.
There are also some references to Flink not needing to sync changes to the
file system due to its checkpointing ability. `setUseFsync` is set to `false`,
it appears, for all settings. Currently, there are some references to not
needing syncing in the Java documentation, but they don't quite make sense
because `setUseFsync` is not mentioned there. Instead, as the existing
documentation suggests, options common to each predefined set are set
elsewhere. So, I removed most duplicate references to `setUseFsync`.
## Brief change log
* Remove references to `disableDataSync` in RocksDB documentation. This is
not set, and has been removed from RocksDB for some time.
* Make Python documentation consistent with Java documentation by removing
`setUseFsync` references on each option.
* Sort options in both Java and Python documentation.
* Sort the code setting configuration to match the sorted-order
documentation.
* Change use of `setIncreaseParallelism` in Python documentation to
`setMaxBackgroundJobs`, which matches the Java usage.
* Add missing Bloom filter option to the `SPINNING_DISK_OPTIMIZED_HIGH_MEM`
documentation, and describe where its parameters are set.
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): **no**
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: **no**
- The serializers: **no**
- The runtime per-record code paths (performance sensitive): **no**
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn, ZooKeeper: **no**
- The S3 file system connector: **no**
## Documentation
- Does this pull request introduce a new feature? **no**
- If yes, how is the feature documented? **not applicable**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
