zentol opened a new pull request #10748: [FLINK-15458][conf][docs] Add support 
for whitelisting ambiguous options 
URL: https://github.com/apache/flink/pull/10748
 
 
   The `ConfigOptionsDocsCompletenessITCase` verifies that all existing and 
documented options are well-defined; as in that for any key there is exactly 1 
default and description present, globally.
   
   There is one use-case however where this check is too strict: reporters. 
These only work with key suffixes (like "port") and hence are failing this 
check. As a result we don't use the generator mechanism for reporters, which is 
unfortunate.
   
   This PR introduces a whitelisting mechanism that allows us to define a set 
of keys for which this check is not performed.
   Note that the remaining checks of the test are still applied. (Is the option 
documented, does the documented option exist, do the defaults/description 
match).
   
   The changes are mostly a refactoring of the test. Previously the test was 
checking whether an ambiguous key exists during the discovery of keys, which 
was now separated.
   This implies that during discovery we no longer end up with a 1:1 mapping of 
key:option, but rather 1:N which is later checked.

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to