[doc] update docs (#12615)

2022-09-15 11:07:34 +08:00
parent 1080095f46
commit 353bb6fdfb
10 changed files with 74 additions and 44 deletions
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@ -52,6 +52,7 @@ ENV REPOSITORY_URL="https://doris-thirdparty-repo.bj.bcebos.com/thirdparty/" \
    DEFAULT_DIR="/var/local" \
    JAVA_HOME="/usr/lib/jvm/java-1.8.0" \
    PATH="/var/local/ldb-toolchain/bin/:$PATH"
+    # USE_AVX2=0 # set it when building no-avx2 image

 # disable auto enable ccache
 RUN rm -f /etc/profile.d/ccache.*
--- a/docs/en/community/release-and-verify/release-complete.md
+++ b/docs/en/community/release-and-verify/release-complete.md
@ -33,6 +33,8 @@ The steps in this document follow after the release has been voted on and approv
 When the official release poll is successful, send the [Result] email first, then prepare the release package.
 Copy the source package, signature file and hash file from the corresponding folder of the previous release under dev to another directory 1.xx, note that the file name should not be rcxx (you can rename, but do not recalculate the signature, the hash can be recalculated, the result will not change)

+> Only PMC members have permission to operate this step.
+
 ```
 From:
 https://dist.apache.org/repos/dist/dev/doris/
--- a/docs/en/community/team.md
+++ b/docs/en/community/team.md
@ -48,7 +48,7 @@ We'd like to thank the following committers to the Apache Doris project who have
 | [yangzhg](https://people.apache.org/committer-index.html#yangzhg) | yangzhg             | Zhengguo Yang |
 | [weizuo](https://people.apache.org/committer-index.html#weizuo) | weizuo93            | Zuo Wei       |

-## Committers (38)
+## Committers (45)

 (the listing excludes PMC members above)

@ -77,6 +77,13 @@ We'd like to thank the following committers to the Apache Doris project who have
 | [wyf](https://people.apache.org/committer-index.html#wyf)    | wuyunfeng        | Yunfeng Wu     |
 | [zenoyang](https://people.apache.org/committer-index.html#zenoyang)    |  zenoyang       | Zeno Yang     |
 | [zshao](https://people.apache.org/committer-index.html#zshao)    | zshao        | Zheng Shao |
+| [morrysnow](https://people.apache.org/committer-index.html#morrysnow)    | morrySnow  | Wenxin Zhang |
+| [jakevin](https://people.apache.org/committer-index.html#jakevin)    | jackwener | Jie Wen |
+| [gabriellee](https://people.apache.org/committer-index.html#gabriellee)    | Gabriel39 | Wenqiang Li |
+| [stalary](https://people.apache.org/committer-index.html#stalary)    | stalary | Rongqian Li |
+| [cambyzju](https://people.apache.org/committer-index.html#cambyzju)    | cambyzju | Xiaoli Zhu  |
+| [adonisling](https://people.apache.org/committer-index.html#adonisling)    | adonis0147  | Cong Ling |
+| [pengxiangyu](https://people.apache.org/committer-index.html#pengxiangyu)    | pengxiangyu | Xiangyu Peng |

 ## Contributors

--- a/docs/en/docs/data-table/basic-usage.md
+++ b/docs/en/docs/data-table/basic-usage.md
@ -614,7 +614,7 @@ The default way to implement Join is to filter the small table conditionally, br

 In this case, it is recommended to explicitly specify Shuffle Join, also known as Partitioned Join, where both the small and large tables are Hashed according to the key of the join and then perform a distributed join, with the memory consumption being spread across all compute nodes in the cluster.

-Doris will automatically attempt a Broadcast Join and switch to a Shuffle Join if the small table is estimated to be too large; note that if a Broadcast Join is explicitly specified at this point, it will also switch to a Shuffle Join.
+Doris will automatically attempt a Broadcast Join and switch to a Shuffle Join if the small table is estimated to be too large; note that if a Broadcast Join is explicitly specified at this point, it will enforce Broadcast Join.

 Use Broadcast Join (default):

--- a/docs/en/docs/install/source-install/compilation.md
+++ b/docs/en/docs/install/source-install/compilation.md
@ -59,31 +59,34 @@ This document focuses on how to code Doris through source code.
 | apache/incubator-doris:build-env-latest | before [0efef1b](https://github.com/apache/doris/commit/0efef1b332300887ee0473f9df9bdd9d7297d824) | |
 | apache/doris:build-env-for-1.0.0| | 1.0.0 |
 | apache/doris:build-env-for-1.1.0| | 1.1.0 |
-| apache/doris:build-env-ldb-toolchain-latest | trunk | trunk |
+| apache/doris:build-env-ldb-toolchain-latest | | 1.1.x, trunk |
+| apache/doris:build-env-ldb-toolchain-no-avx2-latest | | 1.1.x, trunk |

 **note**:

-> 1. Dev docker image [ChangeLog](https://github.com/apache/doris/blob/master/thirdparty/CHANGELOG.md)
+> 1. Third-party libraries in images with no-avx2 in their names that can run on CPUs that do not support avx2 instructions. Doris can be compiled with the USE_AVX2=0 option.

-> 2. Doris version 0.14.0 still uses apache/incubator-doris:build-env-1.2 to compile, and the 0.14.x code will use apache/incubator-doris:build-env-1.3.1.
+> 2. Dev docker image [ChangeLog](https://github.com/apache/doris/blob/master/thirdparty/CHANGELOG.md)

-> 3. From docker image of build-env-1.3.1, both OpenJDK 8 and OpenJDK 11 are included, and OpenJDK 11 is used for compilation by default. Please make sure that the JDK version used for compiling is the same as the JDK version used at runtime, otherwise it may cause unexpected operation errors. You can use the following command to switch the default JDK version in container:
->
->   Switch to JDK 8:
->
->   ```
->   $ alternatives --set java java-1.8.0-openjdk.x86_64
->   $ alternatives --set javac java-1.8.0-openjdk.x86_64
->   $ export JAVA_HOME=/usr/lib/jvm/java-1.8.0
->   ```
->
->   Switch to JDK 11:
->
->   ```
->   $ alternatives --set java java-11-openjdk.x86_64
->   $ alternatives --set javac java-11-openjdk.x86_64
->   $ export JAVA_HOME=/usr/lib/jvm/java-11
->   ```
+> 3. Doris version 0.14.0 still uses apache/incubator-doris:build-env-1.2 to compile, and the 0.14.x code will use apache/incubator-doris:build-env-1.3.1.
+
+> 4. Since the docker image of build-env-1.3.1 includes both OpenJDK 8 and OpenJDK 11, please confirm the default JDK version with `java -version`. You can also switch versions in the following ways (it is recommended to use JDK8 by default)
+    >
+    >   Switch to JDK 8:
+    >
+    >   ```
+    >   alternatives --set java java-1.8.0-openjdk.x86_64
+    >   alternatives --set javac java-1.8.0-openjdk.x86_64
+    >   export JAVA_HOME=/usr/lib/jvm/java-1.8.0
+    >   ```
+    >
+    >   Switch to JDK 11:
+    >
+    >   ```
+    >   alternatives --set java java-11-openjdk.x86_64
+    >   alternatives --set javac java-11-openjdk.x86_64
+    >   export JAVA_HOME=/usr/lib/jvm/java-11
+    >   ```

 2. Running Mirror

--- a/docs/zh-CN/community/release-and-verify/release-complete.md
+++ b/docs/zh-CN/community/release-and-verify/release-complete.md
@ -33,6 +33,8 @@ under the License.
 当正式发布投票成功后，先发[Result]邮件，然后就准备 release package。
 将之前在dev下发布的对应文件夹下的源码包、签名文件和hash文件拷贝到另一个目录 1.1.0，注意文件名字中不要rcxx (可以rename，但不要重新计算签名，hash可以重新计算，结果不会变)

+> 这一步仅PMC成员有权限操作。
+
 ```
 From:
 https://dist.apache.org/repos/dist/dev/doris/
--- a/docs/zh-CN/community/team.md
+++ b/docs/zh-CN/community/team.md
@ -48,7 +48,7 @@ under the License.
 | [yangzhg](https://people.apache.org/committer-index.html#yangzhg) | yangzhg             | Zhengguo Yang |
 | [weizuo](https://people.apache.org/committer-index.html#weizuo) | weizuo93            | Zuo Wei       |

-## Committers (38)
+## Committers (45)

 (如下列表不包含上述 PMC 成员)

@ -77,6 +77,13 @@ under the License.
 | [wyf](https://people.apache.org/committer-index.html#wyf)    | wuyunfeng        | Yunfeng Wu     |
 | [zenoyang](https://people.apache.org/committer-index.html#zenoyang)    | zenoyang  | Zeno Yang     |
 | [zshao](https://people.apache.org/committer-index.html#zshao)    | zshao | Zheng Shao |
+| [morrysnow](https://people.apache.org/committer-index.html#morrysnow)    | morrySnow  | Wenxin Zhang |
+| [jakevin](https://people.apache.org/committer-index.html#jakevin)    | jackwener | Jie Wen |
+| [gabriellee](https://people.apache.org/committer-index.html#gabriellee)    | Gabriel39 | Wenqiang Li |
+| [stalary](https://people.apache.org/committer-index.html#stalary)    | stalary | Rongqian Li |
+| [cambyzju](https://people.apache.org/committer-index.html#cambyzju)    | cambyzju | Xiaoli Zhu  |
+| [adonisling](https://people.apache.org/committer-index.html#adonisling)    | adonis0147  | Cong Ling |
+| [pengxiangyu](https://people.apache.org/committer-index.html#pengxiangyu)    | pengxiangyu | Xiangyu Peng |

 ## Contributors

--- a/docs/zh-CN/docs/data-table/basic-usage.md
+++ b/docs/zh-CN/docs/data-table/basic-usage.md
@ -637,7 +637,7 @@ Query OK, 0 rows affected (0.00 sec)

 如果遇到上述情况，建议显式指定 Shuffle Join，也被称作 Partitioned Join。即将小表和大表都按照 Join 的 key 进行 Hash，然后进行分布式的 Join。这个对内存的消耗就会分摊到集群的所有计算节点上。

-Doris会自动尝试进行 Broadcast Join，如果预估小表过大则会自动切换至 Shuffle Join。注意，如果此时显式指定了 Broadcast Join 也会自动切换至 Shuffle Join。
+Doris会自动尝试进行 Broadcast Join，如果预估小表过大则会自动切换至 Shuffle Join。注意，如果此时显式指定了 Broadcast Join，则会强制执行 Broadcast Join。

 使用 Broadcast Join（默认）:

--- a/docs/zh-CN/docs/install/source-install/compilation.md
+++ b/docs/zh-CN/docs/install/source-install/compilation.md
@ -58,31 +58,34 @@ under the License.
 | apache/incubator-doris:build-env-latest | before [0efef1b](https://github.com/apache/doris/commit/0efef1b332300887ee0473f9df9bdd9d7297d824) | |
 | apache/doris:build-env-for-1.0.0| | 1.0.0 |
 | apache/doris:build-env-for-1.1.0| | 1.1.0 |
-| apache/doris:build-env-ldb-toolchain-latest | trunk | |
+| apache/doris:build-env-ldb-toolchain-latest | | 1.1.x, trunk |
+| apache/doris:build-env-ldb-toolchain-no-avx2-latest | | 1.1.x, trunk |

 **注意**：

-> 1. 编译镜像 [ChangeLog](https://github.com/apache/doris/blob/master/thirdparty/CHANGELOG.md)。
+> 1. 名称中带有 no-avx2 字样的镜像中的第三方库，可以运行在不支持 avx2 指令的 CPU 上。可以配合 USE_AVX2=0 选项，编译 Doris。

-> 2. doris 0.14.0 版本仍然使用apache/incubator-doris:build-env-1.2 编译，0.14.x 版本的代码将使用apache/incubator-doris:build-env-1.3.1。
+> 2. 编译镜像 [ChangeLog](https://github.com/apache/doris/blob/master/thirdparty/CHANGELOG.md)。

-> 3. 从 build-env-1.3.1 的docker镜像起，同时包含了 OpenJDK 8 和 OpenJDK 11，并且默认使用 OpenJDK 11 编译。请确保编译使用的 JDK 版本和运行时使用的 JDK 版本一致，否则会导致非预期的运行错误。你可以在进入编译镜像的容器后，使用以下命令切换默认 JDK 版本：
-     >
-     >   切换到 JDK 8：
-     >
-     >   ```
->   $ alternatives --set java java-1.8.0-openjdk.x86_64
->   $ alternatives --set javac java-1.8.0-openjdk.x86_64
->   $ export JAVA_HOME=/usr/lib/jvm/java-1.8.0
->   ```
-     >
-     >   切换到 JDK 11：
-     >
-     >   ```
->   $ alternatives --set java java-11-openjdk.x86_64
->   $ alternatives --set javac java-11-openjdk.x86_64
->   $ export JAVA_HOME=/usr/lib/jvm/java-11
->   ```
+> 3. doris 0.14.0 版本仍然使用apache/incubator-doris:build-env-1.2 编译，0.14.x 版本的代码将使用apache/incubator-doris:build-env-1.3.1。
+
+> 4. 从 build-env-1.3.1 的docker镜像起，同时包含了 OpenJDK 8 和 OpenJDK 11，请通过 `java -version` 确认默认 JDK 版本。也可以通过以下方式切换版本（建议默认使用 JDK8）
+    >
+    >   切换到 JDK 8：
+    >
+    >   ```
+    >   alternatives --set java java-1.8.0-openjdk.x86_64
+    >   alternatives --set javac java-1.8.0-openjdk.x86_64
+    >   export JAVA_HOME=/usr/lib/jvm/java-1.8.0
+    >   ```
+    >
+    >   切换到 JDK 11：
+    >
+    >   ```
+    >   alternatives --set java java-11-openjdk.x86_64
+    >   alternatives --set javac java-11-openjdk.x86_64
+    >   export JAVA_HOME=/usr/lib/jvm/java-11
+    >   ```

 2. 运行镜像

--- a/thirdparty/CHANGELOG.md
+++ b/thirdparty/CHANGELOG.md
@ -2,6 +2,11 @@

 This file contains version of the third-party dependency libraries in the build-env image. The docker build-env image is apache/doris, and the tag is `build-env-${version}`

+## v20220914
+
+- Added: xxhash 0.8.1
+- Added: jemalloc 5.2.1, Build jemalloc separately, and name it as jemalloc_doris, to distinguish it from jemalloc in arrow.
+
 ## v20220811
 - Modified: brpc 1.1.0 -> 1.2.0 fix _dl_sym undefined reference on Ubuntu22.04