Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Surbhi-Vijay committed Oct 31, 2023
1 parent a7b68c3 commit 9675f04
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 11 deletions.
6 changes: 5 additions & 1 deletion cpp/compile.sh
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,11 @@ CURRENT_DIR=$(

#gluten cpp will find arrow/parquet lib from ARROW_HOME
if [ "$ARROW_HOME" == "" ]; then
ARROW_HOME="$CURRENT_DIR/../ep/build-velox/build/velox_ep/_build/release/third_party/arrow_ep"
if ["$BUILD_TYPE" == "Debug"] then
ARROW_HOME="$CURRENT_DIR/../ep/build-velox/build/velox_ep/_build/debug/third_party/arrow_ep"
else
ARROW_HOME="$CURRENT_DIR/../ep/build-velox/build/velox_ep/_build/release/third_party/arrow_ep"
fi
fi

#gluten cpp will find velox lib from VELOX_HOME
Expand Down
13 changes: 3 additions & 10 deletions docs/get-started/Velox.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,13 @@ cd /path/to/gluten
./dev/builddeps-veloxbe.sh
```

**Build Velox or Arrow separately**
**Build Velox separately**

Scripts under `/path/to/gluten/ep/build-xxx/src` provide `get_xxx.sh` and `build_xxx.sh` to build Velox or Arrow separately, you could use these scripts with custom repo/branch/location.
Scripts under `/path/to/gluten/ep/build-xxx/src` provide `get_xxx.sh` and `build_xxx.sh` to build Velox separately, you could use these scripts with custom repo/branch/location.

Velox can use pre-build arrow/parquet lib from ARROW_HOME parsed by --arrow_home to decrease build time.
Gluten cpp module need a required VELOX_HOME parsed by --velox_home and an optional ARROW_HOME by --arrow_home, if you specify custom ep location, make sure these variables be passed correctly.
Velox provides arrow/parquet lib. Gluten cpp module need a required VELOX_HOME parsed by --velox_home, if you specify custom ep location, make sure these variables be passed correctly.

```bash
## fetch Arrow and compile
cd /path/to/gluten/ep/build-arrow/src/
## you could use custom ep location by --arrow_home=custom_path, make sure specify --arrow_home in build_arrow.sh too.
./get_arrow.sh
./build_arrow.sh

## fetch Velox and compile
cd /path/to/gluten/ep/build-velox/src/
## you could use custom ep location by --velox_home=custom_path, make sure specify --velox_home in build_velox.sh too.
Expand Down

0 comments on commit 9675f04

Please sign in to comment.