(incubator-gluten) branch main updated: [DOC] Add Mac development document (#11547)

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

marong 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 c1adbc4c55 [DOC] Add Mac development document (#11547)
c1adbc4c55 is described below

commit c1adbc4c55a7cd36731f18a6e36b2338e0d23bd2
Author: Jin Chengcheng <Ch...@ibm.com>
AuthorDate: Tue Feb 3 20:17:01 2026 +0800

    [DOC] Add Mac development document (#11547)
---
 docs/developers/NewToGluten.md     |  36 ++++++++++++++++++++++++++++++++++++
 docs/image/IDEA-jdk.png            | Bin 0 -> 70828 bytes
 docs/image/IDEA-scala-compiler.png | Bin 0 -> 245540 bytes
 3 files changed, 36 insertions(+)

diff --git a/docs/developers/NewToGluten.md b/docs/developers/NewToGluten.md
index 3262f985f0..2d11cfba81 100644
--- a/docs/developers/NewToGluten.md
+++ b/docs/developers/NewToGluten.md
@@ -243,6 +243,42 @@ To check Surefire reports:
 
 ![](../image/surefire-report.png)  
 
+### Mac development
+
+#### Compile
+Gluten does not provide a prebuilt JAR for macOS. However, you can compile it yourself and run or debug it locally using an IDE.
+
+First, set the installation prefix for dependencies:
+```bash
+export INSTALL_PREFIX=$HOME/velox/deps-install
+```
+
+All Velox-related libraries will be installed under the directory specified by `INSTALL_PREFIX`.
+
+Use the following commands to build Gluten. Note that on macOS you must disable tests (--build_tests=OFF), as some tests do not run successfully.
+
+```bash
+# Build velox and gluten-cpp
+./dev/builddeps-veloxbe.sh --run_setup_script=ON --build_arrow=ON --build_tests=OFF
+# Build java code
+mvn clean install -Pbackends-velox -Pspark-3.4 -DskipTests
+```
+
+Note: follow the steps in [build-gluten-with-velox-backend](../get-started/Velox.md#build-gluten-with-velox-backend).
+
+After the build completes, you can use your IDE to run and debug Gluten locally.
+
+#### Intellij debug
+
+Intellij requires two extra config to execute the unit test.
+1. Set the JDK to Azul zulu - aarch64
+
+![](../image/IDEA-jdk.png)
+
+2. Set scala compiler `Incrementality type` to `IDEA`
+
+![](../image/IDEA-scala-compiler.png)
+
 ## Debug C++ Code with Core Dump
 
 ```bash
diff --git a/docs/image/IDEA-jdk.png b/docs/image/IDEA-jdk.png
new file mode 100644
index 0000000000..65f84a7e8b
Binary files /dev/null and b/docs/image/IDEA-jdk.png differ
diff --git a/docs/image/IDEA-scala-compiler.png b/docs/image/IDEA-scala-compiler.png
new file mode 100644
index 0000000000..35b6208417
Binary files /dev/null and b/docs/image/IDEA-scala-compiler.png differ


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@gluten.apache.org
For additional commands, e-mail: commits-help@gluten.apache.org