From e081fb46e237586c89773ed0f51f8729eaa2e1a1 Mon Sep 17 00:00:00 2001
From: Dawid Wysakowicz <dwysakowicz@apache.org>
Date: Tue, 21 Jan 2020 11:30:48 +0100
Subject: [PATCH] [FLINK-15684][docs] Add taskmanager.memory.flink.size to
 common options

This closes #10916
---
 .../configuration/TaskManagerOptions.java     | 21 ++++++++++++-------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java
index a1a91cb8cbf412..cfd535aa498239 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java
@@ -257,20 +257,25 @@ public class TaskManagerOptions {
 		key("taskmanager.memory.process.size")
 			.memoryType()
 			.noDefaultValue()
-			.withDescription("Total Process Memory size for the TaskExecutors. This includes all the memory that a"
-				+ " TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On"
-				+ " containerized setups, this should be set to the container memory.");
+			.withDescription("Total Process Memory size for the TaskExecutors. This includes all the memory that a "
+				+ "TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On "
+				+ "containerized setups, this should be set to the container memory. See also "
+				+ "'taskmanager.memory.flink.size' for total Flink memory size configuration."
+			);
 
 	/**
 	 * Total Flink Memory size for the TaskExecutors.
 	 */
+	@Documentation.CommonOption(position = Documentation.CommonOption.POSITION_MEMORY)
 	public static final ConfigOption<MemorySize> TOTAL_FLINK_MEMORY =
 		key("taskmanager.memory.flink.size")
-		.memoryType()
-		.noDefaultValue()
-		.withDescription("Total Flink Memory size for the TaskExecutors. This includes all the memory that a"
-			+ " TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory,"
-			+ " Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory.");
+			.memoryType()
+			.noDefaultValue()
+			.withDescription(String.format("Total Flink Memory size for the TaskExecutors. This includes all the "
+					+ "memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of "
+					+ "Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network "
+					+ "Memory. See also '%s' for total process memory size configuration.",
+				TOTAL_PROCESS_MEMORY.key()));
 
 	/**
 	 * Framework Heap Memory size for TaskExecutors.