This is an automated email from the ASF dual-hosted git repository.
trohrmann pushed a commit to branch release-1.13
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/release-1.13 by this push:
new 055f231 [FLINK-22476][docs] Extend the description of the config
option `execution.target`
055f231 is described below
commit 055f23164c5b7c8177b7a5ac7dd5b4e3d2233d55
Author: Tony Wei <[email protected]>
AuthorDate: Mon Apr 26 17:51:53 2021 +0800
[FLINK-22476][docs] Extend the description of the config option
`execution.target`
This closes #15777.
---
.../layouts/shortcodes/generated/deployment_configuration.html | 2 +-
.../java/org/apache/flink/configuration/DeploymentOptions.java | 10 ++++++++--
2 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/deployment_configuration.html
b/docs/layouts/shortcodes/generated/deployment_configuration.html
index 551e3c8..8a81dfd 100644
--- a/docs/layouts/shortcodes/generated/deployment_configuration.html
+++ b/docs/layouts/shortcodes/generated/deployment_configuration.html
@@ -30,7 +30,7 @@
<td><h5>execution.target</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
- <td>The deployment target for the execution. This can take one of
the following
values:<ul><li>remote</li><li>local</li><li>yarn-per-job</li><li>yarn-session</li><li>kubernetes-session</li></ul>.</td>
+ <td>The deployment target for the execution. This can take one of
the following values when calling <code class="highlighter-rouge">bin/flink
run</code>:<ul><li>remote</li><li>local</li><li>yarn-per-job</li><li>yarn-session</li><li>kubernetes-session</li></ul>And
one of the following values when calling <code
class="highlighter-rouge">bin/flink
run-application</code>:<ul><li>yarn-application</li><li>kubernetes-application</li></ul></td>
</tr>
</tbody>
</table>
diff --git
a/flink-core/src/main/java/org/apache/flink/configuration/DeploymentOptions.java
b/flink-core/src/main/java/org/apache/flink/configuration/DeploymentOptions.java
index b9f62eb..ace0679 100644
---
a/flink-core/src/main/java/org/apache/flink/configuration/DeploymentOptions.java
+++
b/flink-core/src/main/java/org/apache/flink/configuration/DeploymentOptions.java
@@ -20,6 +20,7 @@ package org.apache.flink.configuration;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.configuration.description.Description;
+import org.apache.flink.configuration.description.TextElement;
import java.util.List;
@@ -37,14 +38,19 @@ public class DeploymentOptions {
.withDescription(
Description.builder()
.text(
- "The deployment target for the
execution. This can take one of the following values:")
+ "The deployment target for the
execution. This can take one of the following values "
+ + "when calling %s:",
+ TextElement.code("bin/flink run"))
.list(
text("remote"),
text("local"),
text("yarn-per-job"),
text("yarn-session"),
text("kubernetes-session"))
- .text(".")
+ .text(
+ "And one of the following values
when calling %s:",
+ TextElement.code("bin/flink
run-application"))
+ .list(text("yarn-application"),
text("kubernetes-application"))
.build());
public static final ConfigOption<Boolean> ATTACHED =
