[
https://issues.apache.org/jira/browse/FLINK-8683?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16367999#comment-16367999
]
ASF GitHub Bot commented on FLINK-8683:
---------------------------------------
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5515
[FLINK-8683][docs] Add test for configuration docs completeness
## What is the purpose of the change
This PR adds a test to verify that the documentation is complete and
up-to-date. As a prerequisite FLINK-8684 was also addressed.
The test parses the documented config options, analyzes the actually
existing config options and compares the 2 sets.
Should the test fail the reader is directed to the README.md in flink-docs
that contains instructions on how to regenerate the docs.
## Brief change log
FLINK-8684:
* modify `MesosTaskManagerParameters#MESOS_RM_TASKS_SLOTS` to be a simple
alias
Refactorings to `ConfigOptionsDocGenerator` to make certain parts usable
from the test
* locations are no longer configured in the pom but as a static array in
the generator
* class file name pattern moved into static field, and can now also be
applied to the simple name of a class
* special case handling for options using
`System.getProperty("java.io.tmpdir")` as the default moved into
`defaultValueToHtml` to consolidate default value handling
* refactor `Generator#createTable` to allow re-usage of the `ConfigOption`
detection logic. The method now accepts a `ThrowingConsumer` that is applied to
each class found.
FLINK-8683:
* added jsoup dependency for HTML parsing (MIT license)
* delete `ConfigDocsCompletenessChecker` as the test subsumes it
* modify visibility of several members of the generator to be usable by the
test
* add ConfigOptionsDocsCompletenessTest
## Verifying this change
FLINK-8684 is a trivial change.
The refactorings to the generator are covered by tests and can be manually
verified by regenerating the docs and making sure that no file was modified.
The test can be verified manually by
* adding a new config option
* modify an existing config option in any way
* modify an entry in the documentation files in any way
without regenerating the docs and running `mvn verify`.
## 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, Yarn/Mesos, ZooKeeper: (no)
- The S3 file system connector: (no)
## Documentation
- Does this pull request introduce a new feature? (yes)
- If yes, how is the feature documented? (not applicable)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8683
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5515.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5515
----
commit d533abec84d1423a5a127acc4dc926e3a176608d
Author: zentol <chesnay@...>
Date: 2018-02-16T21:42:51Z
[FLINK-8684][mesos] Make MESOS_RM_TASKS_SLOTS an alias
commit eceb383df8e2663871b2afde9eb3846e8c0d0114
Author: zentol <chesnay@...>
Date: 2018-02-16T21:44:36Z
Move module configuration into static array
commit 14aac29a3250a0ddeb7d3a7a790584dc649cd648
Author: zentol <chesnay@...>
Date: 2018-02-16T21:48:18Z
Move java.io.tmpdir special case processing into #defaultValueToHtml
commit b9dcde0979f44fe8250b698c0bc574b5f9d39c48
Author: zentol <chesnay@...>
Date: 2018-02-16T22:09:54Z
Move pattern into static field
commit b7d107cad39eca5cfa5fec28681fa2653e1cb517
Author: zentol <chesnay@...>
Date: 2018-02-16T22:30:44Z
refactor Generator#createTable to be partially re-usable
commit c51f5d05f364db18551eda0a99ab8a6c32590b65
Author: zentol <chesnay@...>
Date: 2018-02-16T22:52:15Z
[FLINK-8683][docs] Add test for configuration docs completeness
----
> Add test for configuration docs completeness
> --------------------------------------------
>
> Key: FLINK-8683
> URL: https://issues.apache.org/jira/browse/FLINK-8683
> Project: Flink
> Issue Type: Improvement
> Components: Configuration, Documentation, Tests
> Affects Versions: 1.5.0
> Reporter: Chesnay Schepler
> Assignee: Chesnay Schepler
> Priority: Major
> Fix For: 1.5.0
>
>
> We should add a test to make sure the configuration docs stay up-to-date.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
