[
https://issues.apache.org/jira/browse/FLINK-30862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17682975#comment-17682975
]
Jing Ge edited comment on FLINK-30862 at 2/1/23 11:42 AM:
----------------------------------------------------------
Fair enough. Thanks for the info. The question is why we didn't clean up and
remove all deprecated options regularly, like e.g. after one/two release cycles?
Btw. NIT, I didn't make the description clear enough. The content of deprecated
ConfigOption will be generated with a "deprecated" flag. I will update the
description.
was (Author: jingge):
Fair enough. Thanks for the info. The question is why we didn't clean up and
remove all deprecated options regularly?
Btw. NIT, I didn't make the description clear enough. The content of deprecated
ConfigOption will be generated with a "deprecated" flag. I will update the
description.
> Config doc generation should keep @deprecated ConfigOption
> ----------------------------------------------------------
>
> Key: FLINK-30862
> URL: https://issues.apache.org/jira/browse/FLINK-30862
> Project: Flink
> Issue Type: Improvement
> Reporter: Jing Ge
> Assignee: Jing Ge
> Priority: Major
>
> Currently the content will be removed once the ConfigOption is marked as
> @deprecated. The content should be kept and marked with a deprecated flag,
> since the ConfigOption is only deprecated and still be used. The content
> should be only removed when the ConfigOption has been removed.
>
> If we just remove the fresh deprecated option, user will be confused and
> think the option is gone and does not work anymore, which means the backward
> compatibility is broken.
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
