docs: retire Bazel-provided LLVM build instructions - #1863
Open
adi-IL wants to merge 1 commit into
Open
Conversation
The Bazel build that used bazel/llvm.bzl without LLVM_INSTALL_PATH via the llvm-raw repository is API incompatible with the current Crubit source and the LLVM Bazel build is not actively maintained. The commit hash at bazel/llvm.bzl:56 is stale and updating it still fails with expand_template.bzl missing, as described in the issue. Retire this option in docs/cpp/building.md: remove the standalone bazel build command without LLVM_INSTALL_PATH and add a note that the supported workflow is the prebuilt LLVM tree via LLVM_INSTALL_PATH. This simplifies the user setup and contracts the support surface. Fixes google#3
adi-IL
force-pushed
the
docs/retire-bazel-llvm-install
branch
from
August 25, 2026 06:34
91a00dd to
2aa4b19
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3
What was wrong:
The Bazel section in docs/cpp/building.md documented a build without LLVM_INSTALL_PATH that used bazel/llvm.bzl to download LLVM via the llvm-raw repository. As described in #3, the commit at bazel/llvm.bzl:56 is API incompatible with lifetime_annotations/type_lifetimes.cc and updating the commit still fails with missing bazel_skylib expand_template.bzl. The LLVM Bazel build is not actively maintained, and keeping this option increases user confusion and support surface.
What changed:
In docs/cpp/building.md:101, retired the standalone bazel build command without LLVM_INSTALL_PATH. Added a note that building with the Bazel-provided LLVM installation without LLVM_INSTALL_PATH is not supported and was retired per #3, and that the supported Bazel workflow is the prebuilt LLVM tree via LLVM_INSTALL_PATH at docs/cpp/building.md:110. No code or reversible Copybara transforms were touched.
Testing: