Skip to content

[Doc][Gluten] Add tutorial to compile with gluten#62

Merged
wangxinshuo-bolt merged 3 commits intobytedance:mainfrom
XinShuoWang:gluten_compile
Jan 21, 2026
Merged

[Doc][Gluten] Add tutorial to compile with gluten#62
wangxinshuo-bolt merged 3 commits intobytedance:mainfrom
XinShuoWang:gluten_compile

Conversation

@XinShuoWang
Copy link
Copy Markdown
Contributor

@XinShuoWang XinShuoWang commented Dec 29, 2025

What problem does this PR solve?

Issue Number: close #158

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 🚀 Performance improvement (optimization)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
  • 🔨 Refactoring (no logic changes)
  • 🔧 Build/CI or Infrastructure changes
  • 📝 Documentation only

Description

Currently, Bolt has submitted an initial PR to the Gluten community: apache/gluten#11261, for adding a new Bolt backend, but there is currently a lack of documentation that can compile Bolt+Gluten.

Performance Impact

  • No Impact: This change does not affect the critical path (e.g., build system, doc, error handling).

  • Positive Impact: I have run benchmarks.

    Click to view Benchmark Results
    Paste your google-benchmark or TPC-H results here.
    Before: 10.5s
    After:   8.2s  (+20%)
    
  • Negative Impact: Explained below (e.g., trade-off for correctness).

Release Note

Please describe the changes in this PR

Release Note:

Release Note:
- Add bolt/version/version.h to .gitignore
- Add tutorial to compile Bolt for Gluten in README.md

Checklist (For Author)

  • I have added/updated unit tests (ctest).
  • I have verified the code with local build (Release/Debug).
  • I have run clang-format / linters.
  • (Optional) I have run Sanitizers (ASAN/TSAN) locally for complex C++ changes.
  • No need to test or manual test.

Breaking Changes

  • No

  • Yes (Description: ...)

    Click to view Breaking Changes
    Breaking Changes:
    - Description of the breaking change.
    - Possible solutions or workarounds.
    - Any other relevant information.
    

@yangzhg yangzhg added the documentation Improvements or additions to documentation label Jan 9, 2026
@XinShuoWang XinShuoWang marked this pull request as ready for review January 21, 2026 08:56
Copy link
Copy Markdown
Collaborator

@zhangxffff zhangxffff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@XinShuoWang XinShuoWang changed the title Add tutorial to compile with gluten [Doc][Gluten] Add tutorial to compile with gluten Jan 21, 2026
```shell
cd bolt
make release_spark
make export_release
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make install


### Importing Bolt as a library
#### Building Bolt for other system
You can use the `make release && make export_release` command to compile and export Bolt, and then use conan to reference Bolt. Below is a conanfile example that references Bolt as a third-party dependency.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make install

@wangxinshuo-bolt wangxinshuo-bolt merged commit 3014709 into bytedance:main Jan 21, 2026
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] A document is needed to describe how to compile with Gluten (bolt backend)

5 participants