diff --git a/core/src/main/scala/org/apache/spark/internal/config/package.scala b/core/src/main/scala/org/apache/spark/internal/config/package.scala index 7527f2ef677c5..652db2bdf90a9 100644 --- a/core/src/main/scala/org/apache/spark/internal/config/package.scala +++ b/core/src/main/scala/org/apache/spark/internal/config/package.scala @@ -191,15 +191,15 @@ package object config { private[spark] val EVENT_LOG_ENABLE_ROLLING = ConfigBuilder("spark.eventLog.rolling.enabled") - .doc("Whether rolling over event log files is enabled. If set to true, it cuts down " + + .doc("Whether rolling over event log files is enabled. If set to true, it cuts down " + "each event log file to the configured size.") .booleanConf .createWithDefault(false) private[spark] val EVENT_LOG_ROLLING_MAX_FILE_SIZE = ConfigBuilder("spark.eventLog.rolling.maxFileSize") - .doc(s"Precondition: ${EVENT_LOG_ENABLE_ROLLING.key}. " + - "The max size of event log file to be rolled over.") + .doc(s"When ${EVENT_LOG_ENABLE_ROLLING.key}=true, specifies the max size of event log file" + + " to be rolled over.") .bytesConf(ByteUnit.BYTE) .checkValue(_ >= ByteUnit.MiB.toBytes(10), "Max file size of event log should be " + "configured to be at least 10 MiB.") diff --git a/docs/configuration.md b/docs/configuration.md index 1343755f9d87f..6f7d5f5447df7 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1033,7 +1033,7 @@ Apart from these, the following properties are also available, and may be useful spark.eventLog.rolling.maxFileSize 128m - The max size of event log file before it's rolled over. + When spark.eventLog.rolling.enabled=true, specifies the max size of event log file before it's rolled over.