NicoK commented on a change in pull request #7687: [FLINK-11542][config][docs]
Extend memory configuration descriptions
URL: https://github.com/apache/flink/pull/7687#discussion_r259571162
##########
File path:
flink-core/src/main/java/org/apache/flink/configuration/TaskManagerOptions.java
##########
@@ -229,15 +239,21 @@
key("taskmanager.memory.off-heap")
.defaultValue(false)
.withDescription("Memory allocation method (JVM heap or
off-heap), used for managed memory of the" +
- " TaskManager as well as the network buffers.");
+ " TaskManager as well as the network buffers.
For setups with larger quantities of memory, this can" +
+ " improve the efficiency of the operations
performed on the memory .");
/**
* Whether TaskManager managed memory should be pre-allocated when the
TaskManager is starting.
*/
public static final ConfigOption<Boolean> MANAGED_MEMORY_PRE_ALLOCATE =
key("taskmanager.memory.preallocate")
.defaultValue(false)
- .withDescription("Whether TaskManager managed memory
should be pre-allocated when the TaskManager is starting.");
+ .withDescription("Whether TaskManager managed memory
should be pre-allocated when the TaskManager is starting." +
+ " When " + MEMORY_OFF_HEAP.key() + " is set to
true, then it is advised that this configuration is also" +
Review comment:
use `%s` and `code()` for the config key `MEMORY_OFF_HEAP.key()`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
