Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mention calling register_toolchains in custom toolchain docs #2463

Merged
merged 1 commit into from
Dec 3, 2024
+9 −0
Merged

docs: mention calling register_toolchains in custom toolchain docs #2463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/toolchains.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,8 +444,17 @@ toolchain(
],
exec_comaptible_with = ["@platforms/os:linux"]
)

# File: MODULE.bazel or WORKSPACE.bazel
# These toolchains will considered before others
register_toolchains("//toolchains:all")
```

When registering custom toolchains, be aware of the the [toolchain registration
order](https://bazel.build/extending/toolchains#toolchain-resolution). In brief,
toolchain order is the BFS-order of the modules; see the bazel docs for a more
detailed description.

:::{note}
The toolchain() calls should be in a separate BUILD file from everything else.
This avoids Bazel having to perform unnecessary work when it discovers the list
Expand Down