You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by gu...@apache.org on 2019/07/31 03:18:27 UTC

[spark] branch branch-2.4 updated: [MINOR][CORE][DOCS] Fix inconsistent description of showConsoleProgress

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

gurwls223 pushed a commit to branch branch-2.4
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/branch-2.4 by this push:
     new 992b1bb  [MINOR][CORE][DOCS] Fix inconsistent description of showConsoleProgress
992b1bb is described below

commit 992b1bb3697f6ec9fb5fc2853c33b591715dfd76
Author: gengjiaan <ge...@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 <ge...@360.cn>
    Signed-off-by: HyukjinKwon <gu...@apache.org>
    (cherry picked from commit dba4375359a2dfed1f009edc3b1bcf6b3253fe02)
    Signed-off-by: HyukjinKwon <gu...@apache.org>
---
 docs/configuration.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/configuration.md b/docs/configuration.md
index 73bae77..d481986 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -891,11 +891,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-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org