This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch rel/0.13
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/rel/0.13 by this push:
new 73482eb update the WayToGetIoTDB.md (#5278)
73482eb is described below
commit 73482eb92dfad14953c7216ec52ae917d1e96bc5
Author: Xuan Ronaldo <[email protected]>
AuthorDate: Fri Mar 18 18:43:56 2022 +0800
update the WayToGetIoTDB.md (#5278)
---
docs/UserGuide/QuickStart/WayToGetIoTDB.md | 17 ++++++++++++++++-
docs/zh/UserGuide/QuickStart/WayToGetIoTDB.md | 16 +++++++++++++++-
2 files changed, 31 insertions(+), 2 deletions(-)
diff --git a/docs/UserGuide/QuickStart/WayToGetIoTDB.md
b/docs/UserGuide/QuickStart/WayToGetIoTDB.md
index 8f0c282..9f171be 100644
--- a/docs/UserGuide/QuickStart/WayToGetIoTDB.md
+++ b/docs/UserGuide/QuickStart/WayToGetIoTDB.md
@@ -51,7 +51,13 @@ You can download the source code from:
git clone https://github.com/apache/iotdb.git
```
-Under the root path of iotdb:
+After that, go to the root path of IoTDB. If you want to build the version
that we have released, you need to create and check out a new branch by command
`git checkout -b my_{project.version} v{project.version}`. E.g., you want to
build the version `0.12.4`, you can execute this command to make it:
+
+```shell
+> git checkout -b my_0.12.4 v0.12.4
+```
+
+Then you can execute this command to build the version that you want:
```
> mvn clean package -DskipTests
@@ -69,6 +75,15 @@ If you would like to build the IoTDB server, you can run the
following command u
After build, the IoTDB server will be at the folder
"server/target/iotdb-server-{project.version}".
+If you would like to build a module, you can execute command `mvn clean
package -pl {module.name} -am -DskipTests` under the root path of IoTDB.
+If you need the jar with dependencies, you can add parameter `-P
get-jar-with-dependencies` after the command. E.g., If you need the jar of jdbc
with dependencies, you can execute this command:
+
+```shell
+> mvn clean package -pl jdbc -am -DskipTests -P get-jar-with-dependencies
+```
+
+Then you can find it under the path `{module.name}/target`.
+
### Installation by Docker (Dockerfile)
Apache IoTDB' Docker image is released on
[https://hub.docker.com/r/apache/iotdb](https://hub.docker.com/r/apache/iotdb),
diff --git a/docs/zh/UserGuide/QuickStart/WayToGetIoTDB.md
b/docs/zh/UserGuide/QuickStart/WayToGetIoTDB.md
index 6f7f7dd..984dfc7 100644
--- a/docs/zh/UserGuide/QuickStart/WayToGetIoTDB.md
+++ b/docs/zh/UserGuide/QuickStart/WayToGetIoTDB.md
@@ -51,7 +51,13 @@ Shell > uzip iotdb-<version>.zip
您可以获取已发布的源码
[https://iotdb.apache.org/Download/](https://iotdb.apache.org/Download/) ，或者从
[https://github.com/apache/iotdb/tree/master](https://github.com/apache/iotdb/tree/master)
git 仓库获取
-源码克隆后，进入到源码文件夹目录下，使用以下命令进行编译：
+源码克隆后，进入到源码文件夹目录下。如果您想编译已经发布过的版本，可以先用`git checkout -b my_{project.version}
v{project.version}`命令新建并切换分支。比如您要编译0.12.4这个版本，您可以用如下命令去切换分支：
+
+```shell
+> git checkout -b my_0.12.4 v0.12.4
+```
+
+切换分支之后就可以使用以下命令进行编译：
```
> mvn clean package -pl server -am -Dmaven.test.skip=true
@@ -69,6 +75,14 @@ Shell > uzip iotdb-<version>.zip
+- tools/ <-- system tools
```
+如果您想要编译项目中的某个模块，您可以在源码文件夹中使用`mvn clean package -pl {module.name} -am
-DskipTests`命令进行编译。如果您需要的是带依赖的 jar 包，您可以在编译命令后面加上`-P
get-jar-with-dependencies`参数。比如您想编译带依赖的 jdbc jar 包，您就可以使用以下命令进行编译：
+
+```shell
+> mvn clean package -pl jdbc -am -DskipTests -P get-jar-with-dependencies
+```
+
+编译完成后就可以在`{module.name}/target`目录中找到需要的包了。
+
### 通过 Docker 安装 (Dockerfile)
Apache IoTDB 的 Docker 镜像已经上传至
[https://hub.docker.com/r/apache/iotdb](https://hub.docker.com/r/apache/iotdb)，
