You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ul...@apache.org on 2023/01/16 03:11:45 UTC

[kyuubi] branch master updated: [KYUUBI #4173] Eliminate `scalac` warnings for class link in comments

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

ulyssesyou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git


The following commit(s) were added to refs/heads/master by this push:
     new 149c7d208 [KYUUBI #4173] Eliminate `scalac` warnings for class link in comments
149c7d208 is described below

commit 149c7d208cdc30cf0ca8414572c1c5dc1fb2d2d5
Author: liangbowen <li...@gf.com.cn>
AuthorDate: Mon Jan 16 11:11:31 2023 +0800

    [KYUUBI #4173] Eliminate `scalac` warnings for class link in comments
    
    ### _Why are the changes needed?_
    
    Adding following rules to `globalFilters` for `silencer` plugin
    - `.*Could not find any member to link for.*`
    - `.*undefined in comment for class.*`
    
    To refine CI output in a more helpful, to eliminate over 68 class link warnings in Scala comments in single run , as outputs like:
    ```
    /home/runner/work/kyuubi/kyuubi/kyuubi-common/src/main/scala/org/apache/kyuubi/util/KyuubiHadoopUtils.scala:80: warning: Could not find any member to link for "Credentials#tokenMap".
      /**
      ^
    
    /home/runner/work/kyuubi/kyuubi/kyuubi-events/src/main/scala/org/apache/kyuubi/events/handler/JsonLoggingEventHandler.scala:37: warning: Variable eventType undefined in comment for class JsonLoggingEventHandler in class JsonLoggingEventHandler
     *   ${ENGINE_EVENT_JSON_LOG_PATH}/${eventType}/day=${date}/${logName}.json
    ```
    
    ### _How was this patch tested?_
    - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
    
    - [ ] Add screenshots for manual tests if appropriate
    
    - [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #4173 from bowenliang123/scalac-link-warning.
    
    Closes #4173
    
    5ddb7e44 [liangbowen] add `.*undefined in comment for class.*` to silencer
    7053623c [liangbowen] add `.*Could not find any member to link for.*` to silencer
    
    Authored-by: liangbowen <li...@gf.com.cn>
    Signed-off-by: ulysses-you <ul...@apache.org>
---
 pom.xml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pom.xml b/pom.xml
index b7da49088..697115bd6 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1769,6 +1769,8 @@
                             <arg>-explaintypes</arg>
                             <arg>-Yno-adapted-args</arg>
                             <arg>-P:silencer:globalFilters=.*deprecated.*</arg>
+                            <arg>-P:silencer:globalFilters=.*Could not find any member to link for.*</arg>
+                            <arg>-P:silencer:globalFilters=.*undefined in comment for class.*</arg>
                             <arg>-Xfatal-warnings</arg>
                             <arg>-Ywarn-unused:imports</arg>
                         </args>