max/lean4-htt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

doc: how to LLVM upgrade (#13656)

Browse source 
This PR documents how to perform an LLVM upgrade.
This commit is contained in:
Henrik Böving 2026-05-06 12:03:53 +02:00 • committed by GitHub
parent ea6e767078
commit 9533f3f5ac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/dev/llvm_upgrade.md Normal file
View file

@ -0,0 +1,14 @@
To upgrade Lean's LLVM version we currently perform the following steps:
1. Make PR to leanprover/lean-llvm that upgrades the LLVM version, example: https://github.com/leanprover/lean-llvm/pull/15
2. Merge PR to master, create a tag with the LLVM version name and wait for CI to create the release on that tag, example: https://github.com/leanprover/lean-llvm/releases/tag/22.1.4
3. Got to leanprover/lean4 and update all necessary LLVM things there, this is currently:
- bumping the llvm-urls in `.github/workflows/ci.yml`
- bumping `LLVM_RELEASE` in `tests/bench_build.sh` and `tests/bench_other.sh`
- fixing potential build failures
4. Create a PR and run `!bench` to see performance impact, example: https://github.com/leanprover/lean4/pull/13545
5. Run `release-ci` on the PR to ensure everything still works on all platforms
6. Profit!
Note: you might want to create a prerelease tag on lean-llvm and work with that until you are sure
the bump is actually going to work.