This is an automated email from the ASF dual-hosted git repository.
liuneng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git
The following commit(s) were added to refs/heads/main by this push:
new 8ef4ab4f2 [GLUTEN-7224][CH] update doc for compiling ch backend #7227
8ef4ab4f2 is described below
commit 8ef4ab4f2d75bb9c8683594f83ea8d1c5b25228e
Author: lgbo <[email protected]>
AuthorDate: Fri Sep 13 14:36:28 2024 +0800
[GLUTEN-7224][CH] update doc for compiling ch backend #7227
What changes were proposed in this pull request?
(Please fill in changes proposed in this fix)
Fixes: #7224
How was this patch tested?
(Please explain how this patch was tested. E.g. unit tests, integration
tests, manual tests)
unit tests
(If this patch involves UI changes, please attach a screenshot; otherwise,
remove this)
---
docs/get-started/ClickHouse.md | 39 ++++++++++++++++++++++++---------------
1 file changed, 24 insertions(+), 15 deletions(-)
diff --git a/docs/get-started/ClickHouse.md b/docs/get-started/ClickHouse.md
index b12607d96..160582c86 100644
--- a/docs/get-started/ClickHouse.md
+++ b/docs/get-started/ClickHouse.md
@@ -52,7 +52,7 @@ You need to install the following software manually:
Then, get Gluten code:
```shell
- git clone https://github.com/apache/incubator-gluten.git
+git clone https://github.com/apache/incubator-gluten.git
```
#### Setup ClickHouse backend development environment
@@ -60,24 +60,29 @@ Then, get Gluten code:
##### Compile Clickhouse backend
###### clone repos
+clone gluten repo
+
+
+```shell
+git clone https://github.com/apache/incubator-gluten.git
+```
clone Kyligence/ClickHouse repo
- ```shell
- git clone --recursive --shallow-submodules -b clickhouse_backend
https://github.com/Kyligence/ClickHouse.git
- ```
- checkout to the latest branch
- ```shell
- latest_branch=$(cat $gluten_root/cpp-ch/clickhouse.version | grep
CH_BRANCH | cut -d= -f2)
- git checkout -b $latest_branch origin/$latest_branch
- git submodule sync --recursive
- git submodule update --init --recursive
- ```
+
+```shell
+git clone --recursive --shallow-submodules -b clickhouse_backend
https://github.com/Kyligence/ClickHouse.git
+```
+
+checkout to the latest branch
+
+```shell
+latest_branch=$(cat $gluten_root/cpp-ch/clickhouse.version | grep CH_BRANCH |
cut -d= -f2)
+git checkout -b $latest_branch origin/$latest_branch
+git submodule sync --recursive
+git submodule update --init --recursive
+```
-clone gluten repo
- ```shell
- git clone https://github.com/apache/incubator-gluten.git
- ```
##### build
@@ -85,6 +90,7 @@ clone gluten repo
There are several ways to build the backend library.
1. Build it direclty
+
If you have setup all requirements, you can use following command to build it
direclty.
```bash
@@ -98,6 +104,8 @@ The target file is
`$gluten_root/cpp-ch/build/utils/extern-local-engine/libch.so
2. Use docker
+
+
You can use [docker file](../../cpp-ch/local-engine/docker/image/Dockerfile)
to build a docker image
```shell
cd $gluten_root/cpp-ch/local-engine/docker/image/
@@ -137,6 +145,7 @@ cd $gluten_root/cpp-ch/local-engine/docker
4. Build it as a submodule of Clickhouse
+
```shell
ln -s $gluten_root/cpp-ch/local-engine
$clickhouse_root/utils/extern-local-engine
mkdir -p $clickhouse_root/build
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
