[
https://issues.apache.org/jira/browse/FLINK-20914?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ruguo Yu updated FLINK-20914:
-----------------------------
Description:
The description of ConfigOption 'security.ssl.internal.session-cache-size' has
a URL link, as follows:
{code:java}
public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
key("security.ssl.internal.session-cache-size")
.intType()
.defaultValue(-1)
.withDescription(
"The size of the cache used for storing SSL session
objects. "
+ "According to
https://github.com/netty/netty/issues/832, you should always set "
+ "this to an appropriate number to not run
into a bug with stalling IO threads "
+ "during garbage collection. (-1 = use system
default).")
.withDeprecatedKeys("security.ssl.session-cache-size");
{code}
so the most reasonable way is to use *Text Description* with *Link,* as follows:
{code:java}
public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
key("security.ssl.internal.session-cache-size")
.intType()
.defaultValue(-1)
.withDescription(
Description.builder()
.text(
"The size of the cache used for storing
SSL session objects. "
+ "According to %s, you should
always set "
+ "this to an appropriate
number to not run into a bug with stalling IO threads "
+ "during garbage collection.
(-1 = use system default).",
link(
"https://github.com/netty/netty/issues/832";,
"here"))
.build())
.withDeprecatedKeys("security.ssl.session-cache-size");
{code}
was:
The description of ConfigOption 'security.ssl.internal.session-cache-size' has
a URL link, as follows:
{code:java}
public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
key("security.ssl.internal.session-cache-size")
.intType()
.defaultValue(-1)
.withDescription(
"The size of the cache used for storing SSL session
objects. "
+ "According to
https://github.com/netty/netty/issues/832, you should always set "
+ "this to an appropriate number to not run
into a bug with stalling IO threads "
+ "during garbage collection. (-1 = use system
default).")
.withDeprecatedKeys("security.ssl.session-cache-size");
{code}
> Format the description of 'security.ssl.internal.session-cache-size' option
> ---------------------------------------------------------------------------
>
> Key: FLINK-20914
> URL: https://issues.apache.org/jira/browse/FLINK-20914
> Project: Flink
> Issue Type: Improvement
> Components: API / Core
> Affects Versions: 1.12.0
> Reporter: Ruguo Yu
> Priority: Minor
> Labels: pull-request-available
> Fix For: 1.13.0
>
>
> The description of ConfigOption 'security.ssl.internal.session-cache-size'
> has a URL link, as follows:
> {code:java}
> public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
> key("security.ssl.internal.session-cache-size")
> .intType()
> .defaultValue(-1)
> .withDescription(
> "The size of the cache used for storing SSL session
> objects. "
> + "According to
> https://github.com/netty/netty/issues/832, you should always set "
> + "this to an appropriate number to not run
> into a bug with stalling IO threads "
> + "during garbage collection. (-1 = use
> system default).")
> .withDeprecatedKeys("security.ssl.session-cache-size");
> {code}
> so the most reasonable way is to use *Text Description* with *Link,* as
> follows:
> {code:java}
> public static final ConfigOption<Integer> SSL_INTERNAL_SESSION_CACHE_SIZE =
> key("security.ssl.internal.session-cache-size")
> .intType()
> .defaultValue(-1)
> .withDescription(
> Description.builder()
> .text(
> "The size of the cache used for
> storing SSL session objects. "
> + "According to %s, you
> should always set "
> + "this to an appropriate
> number to not run into a bug with stalling IO threads "
> + "during garbage collection.
> (-1 = use system default).",
> link(
>
> "https://github.com/netty/netty/issues/832";,
> "here"))
> .build())
> .withDeprecatedKeys("security.ssl.session-cache-size");
> {code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
