This is an automated email from the ASF dual-hosted git repository.
gurwls223 pushed a commit to branch branch-2.3
in repository https://gitbox.apache.org/repos/asf/spark.git
The following commit(s) were added to refs/heads/branch-2.3 by this push:
new 78d1bb1 [MINOR][CORE][DOCS] Fix inconsistent description of
showConsoleProgress
78d1bb1 is described below
commit 78d1bb188efa55038f63ece70aaa0a5ebaa75f5f
Author: gengjiaan <gengji...@360.cn>
AuthorDate: Wed Jul 31 12:17:44 2019 +0900
[MINOR][CORE][DOCS] Fix inconsistent description of showConsoleProgress
## What changes were proposed in this pull request?
The latest docs http://spark.apache.org/docs/latest/configuration.html
contains some description as below:
spark.ui.showConsoleProgress | true | Show the progress bar in the console.
The progress bar shows the progress of stages that run for longer than 500ms.
If multiple stages run at the same time, multiple progress bars will be
displayed on the same line.
-- | -- | --
But the class `org.apache.spark.internal.config.UI` define the config
`spark.ui.showConsoleProgress` as below:
```
val UI_SHOW_CONSOLE_PROGRESS = ConfigBuilder("spark.ui.showConsoleProgress")
.doc("When true, show the progress bar in the console.")
.booleanConf
.createWithDefault(false)
```
So I think there are exists some little mistake and lead to confuse reader.
## How was this patch tested?
No need UT.
Closes #25297 from beliefer/inconsistent-desc-showConsoleProgress.
Authored-by: gengjiaan <gengji...@360.cn>
Signed-off-by: HyukjinKwon <gurwls...@apache.org>
(cherry picked from commit dba4375359a2dfed1f009edc3b1bcf6b3253fe02)
Signed-off-by: HyukjinKwon <gurwls...@apache.org>
---
docs/configuration.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/configuration.md b/docs/configuration.md
index 42e6d87..822f903 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -867,11 +867,13 @@ Apart from these, the following properties are also
available, and may be useful
</tr>
<tr>
<td><code>spark.ui.showConsoleProgress</code></td>
- <td>true</td>
+ <td>false</td>
<td>
Show the progress bar in the console. The progress bar shows the progress
of stages
that run for longer than 500ms. If multiple stages run at the same time,
multiple
progress bars will be displayed on the same line.
+ <br/>
+ <em>Note:</em> In shell environment, the default value of
spark.ui.showConsoleProgress is true.
</td>
</tr>
<tr>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
