You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tr...@apache.org on 2018/09/17 10:05:52 UTC

[flink] 02/02: [hotfix] Add description to java.env.opts.*

This is an automated email from the ASF dual-hosted git repository.

trohrmann pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit d18fd222cba3dcca90f326398dc9ae37b6267610
Author: Till Rohrmann <tr...@apache.org>
AuthorDate: Fri Sep 14 21:46:00 2018 +0200

    [hotfix] Add description to java.env.opts.*
---
 docs/_includes/generated/environment_configuration.html          | 6 +++---
 .../main/java/org/apache/flink/configuration/CoreOptions.java    | 9 ++++++---
 2 files changed, 9 insertions(+), 6 deletions(-)

diff --git a/docs/_includes/generated/environment_configuration.html b/docs/_includes/generated/environment_configuration.html
index ca70a2b..a54955c 100644
--- a/docs/_includes/generated/environment_configuration.html
+++ b/docs/_includes/generated/environment_configuration.html
@@ -15,7 +15,7 @@
         <tr>
             <td><h5>env.java.opts</h5></td>
             <td style="word-wrap: break-word;">(none)</td>
-            <td></td>
+            <td>Java options to start the JVM of all Flink processes with.</td>
         </tr>
         <tr>
             <td><h5>env.java.opts.historyserver</h5></td>
@@ -25,12 +25,12 @@
         <tr>
             <td><h5>env.java.opts.jobmanager</h5></td>
             <td style="word-wrap: break-word;">(none)</td>
-            <td></td>
+            <td>Java options to start the JVM of the JobManager with.</td>
         </tr>
         <tr>
             <td><h5>env.java.opts.taskmanager</h5></td>
             <td style="word-wrap: break-word;">(none)</td>
-            <td></td>
+            <td>Java options to start the JVM of the TaskManager with.</td>
         </tr>
         <tr>
             <td><h5>env.log.dir</h5></td>
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java
index 37db9f2..9ae807e 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/CoreOptions.java
@@ -131,15 +131,18 @@ public class CoreOptions {
 
 	public static final ConfigOption<String> FLINK_JVM_OPTIONS = ConfigOptions
 		.key("env.java.opts")
-		.defaultValue("");
+		.defaultValue("")
+		.withDescription(Description.builder().text("Java options to start the JVM of all Flink processes with.").build());
 
 	public static final ConfigOption<String> FLINK_JM_JVM_OPTIONS = ConfigOptions
 		.key("env.java.opts.jobmanager")
-		.defaultValue("");
+		.defaultValue("")
+		.withDescription(Description.builder().text("Java options to start the JVM of the JobManager with.").build());
 
 	public static final ConfigOption<String> FLINK_TM_JVM_OPTIONS = ConfigOptions
 		.key("env.java.opts.taskmanager")
-		.defaultValue("");
+		.defaultValue("")
+		.withDescription(Description.builder().text("Java options to start the JVM of the TaskManager with.").build());
 
 	public static final ConfigOption<String> FLINK_HS_JVM_OPTIONS = ConfigOptions
 		.key("env.java.opts.historyserver")