You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kyuubi.apache.org by ch...@apache.org on 2022/08/18 07:38:19 UTC
[incubator-kyuubi] branch master updated: [KYUUBI #3241][DOCS] Update `Develop Tools / Building a Runnable Distribution`
This is an automated email from the ASF dual-hosted git repository.
chengpan 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 05e4e8f8c [KYUUBI #3241][DOCS] Update `Develop Tools / Building a Runnable Distribution`
05e4e8f8c is described below
commit 05e4e8f8c171a911f7ad41c03a6c4db9b18ac25e
Author: zwangsheng <22...@qq.com>
AuthorDate: Thu Aug 18 15:38:09 2022 +0800
[KYUUBI #3241][DOCS] Update `Develop Tools / Building a Runnable Distribution`
### _Why are the changes needed?_
To close #3241
* correct Kyuubi Release Page to https://kyuubi.apache.org/releases.html
* correct binary package name to apache-kyuubi-XXXX.tgz
* correct `buid/dist --help`
### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
- [x] 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 #3265 from zwangsheng/doc/make-distribution.
Closes #3241
8600186c [zwangsheng] modify distribution
Authored-by: zwangsheng <22...@qq.com>
Signed-off-by: Cheng Pan <ch...@apache.org>
---
docs/develop_tools/distribution.md | 21 ++++++++++++---------
1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/docs/develop_tools/distribution.md b/docs/develop_tools/distribution.md
index 46094325c..680f4e212 100644
--- a/docs/develop_tools/distribution.md
+++ b/docs/develop_tools/distribution.md
@@ -18,22 +18,25 @@
# Building a Runnable Distribution
-To create a Kyuubi distribution like those distributed by [Kyuubi Release Page](https://github.com/apache/incubator-kyuubi/releases),
+To create a Kyuubi distribution like those distributed by [Kyuubi Release Page](https://kyuubi.apache.org/releases.html),
and that is laid out to be runnable, use `./build/dist` in the project root directory.
For more information on usage, run `./build/dist --help`
```logtalk
-./build/dist - Tool for making binary distributions of Kyuubi Server
+./build/dist - Tool for making binary distributions of Kyuubi
Usage:
-+--------------------------------------------------------------------------------------+
-| ./build/dist [--name <custom_name>] [--tgz] [--flink-provided] [--spark-provided] <maven build options> |
-+--------------------------------------------------------------------------------------+
++------------------------------------------------------------------------------------------------------+
+| ./build/dist [--name <custom_name>] [--tgz] [--flink-provided] [--spark-provided] [--hive-provided] |
+| [--mvn <maven_executable>] <maven build options> |
++------------------------------------------------------------------------------------------------------+
name: - custom binary name, using project version if undefined
tgz: - whether to make a whole bundled package
flink-provided: - whether to make a package without Flink binary
spark-provided: - whether to make a package without Spark binary
+hive-provided: - whether to make a package without Hive binary
+mvn: - external maven executable location
```
For instance,
@@ -42,12 +45,12 @@ For instance,
./build/dist --name custom-name --tgz
```
-This results in a Kyuubi distribution named `kyuubi-{version}-bin-custom-name.tgz` for you.
+This results in a Kyuubi distribution named `apache-kyuubi-{version}-bin-custom-name.tgz` for you.
-If you are planing to deploy Kyuubi where `spark`/`flink` is provided, in other word, it's not required to bundle spark/flink binary, use
+If you are planing to deploy Kyuubi where `spark`/`flink`/`hive` is provided, in other word, it's not required to bundle spark/flink/hive binary, use
```bash
-./build/dist --tgz --spark-provided --flink-provided
+./build/dist --tgz --spark-provided --flink-provided --hive-provided
```
-Then you will get a Kyuubi distribution without spark binary named `kyuubi-{version}-bin.tgz`.
+Then you will get a Kyuubi distribution without spark/flink/hive binary named `apache-kyuubi-{version}-bin.tgz`.