[
https://issues.apache.org/jira/browse/FLINK-30862?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17683034#comment-17683034
]
Chesnay Schepler commented on FLINK-30862:
------------------------------------------
??The question is why we didn't clean up and remove all deprecated options
regularly, like e.g. after one/two release cycles???
If you are referring to a), then source/binary compatibility.
If you are referring to b), then because there's usually no immediate gain for
us (or users for that matter).
??An alternative, that've just popped in my mind is to have a separate
section/page with all deprecated options.???
Yes, but such a page is imo only useful if you can attach more information to
it, like "this option is deprecated in favor of X" or "this option has no
longer an effect".
This isn't as trivial as documenting new options because many of these
deprecated keys are defined in the {{ConfigConstants}}, i.e. don't use
{{ConfigOption}} at all.
I do wonder though who would look at a page purely about deprecated options.
That's not really what users are searching for, right?
Rather they want to see a migration page, but isn't that what the release notes
are for (which FYI aren't even linked anywhere in the docs and only accessible
via the search).
> 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 in the document, 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)
