You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ya...@apache.org on 2022/04/16 14:33:34 UTC

[incubator-kyuubi] branch master updated: [KYUUBI #2369] [Improvement] update developer.md to describe what append descriptions of new configurations to settings.md

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 1a58aaf78 [KYUUBI #2369] [Improvement] update developer.md to describe what append descriptions of new configurations to settings.md
1a58aaf78 is described below

commit 1a58aaf78ca2e0fd2a06376eb271631609450208
Author: Min Zhao <zh...@163.com>
AuthorDate: Sat Apr 16 22:33:25 2022 +0800

    [KYUUBI #2369] [Improvement] update developer.md to describe what append descriptions of new configurations to settings.md
    
    ### _Why are the changes needed?_
    
    update developer.md to describe what append descriptions of new configurations to settings.md
    
    ### _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
    
    - [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #2372 from zhaomin1423/2369.
    
    Closes #2369
    
    a044c156 [Min Zhao] [KYUUBI #2369] [Improvement] update developer.md to describe what append descriptions of new configurations to settings.md
    56f878a9 [Min Zhao] [KYUUBI #2369] [Improvement] update developer.md to describe what append descriptions of new configurations to settings.md
    581894b7 [Min Zhao] [KYUUBI #2369] [Improvement] update developer.md to describe what append descriptions of new configurations to settings.md
    
    Authored-by: Min Zhao <zh...@163.com>
    Signed-off-by: Kent Yao <ya...@apache.org>
---
 docs/develop_tools/developer.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/docs/develop_tools/developer.md b/docs/develop_tools/developer.md
index 497434dd6..9eb2e311c 100644
--- a/docs/develop_tools/developer.md
+++ b/docs/develop_tools/developer.md
@@ -58,3 +58,11 @@ with [google-java-format](https://github.com/google/google-java-format) and [Sca
 to format the Java and Scala code.
 
 You can run `dev/reformat` to format all Java and Scala code.
+
+
+## Append descriptions of new configurations to settings.md
+
+Kyuubi uses settings.md to explain available configurations.
+
+You can run `KYUUBI_UPDATE=1 build/mvn clean install -Pflink-provided,spark-provided,hive-provided -DwildcardSuites=org.apache.kyuubi.config.AllKyuubiConfiguration`
+to append descriptions of new configurations to settings.md.
\ No newline at end of file