Skip to content

Commit

Permalink
docs: mention calling register_toolchains in custom toolchain docs (#…
Browse files Browse the repository at this point in the history
…2463)

Mention where register_toolchains() should be when defining custom
toolchains. Also link
to the Bazel docs about toolchains.

This stems from Slack discussion where someone was trying to define
custom toolchains and
got hung up on the last step or registering them.
  • Loading branch information
rickeylev authored Dec 3, 2024
1 parent a362339 commit bc8658a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/toolchains.md
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

0 comments on commit bc8658a

Please sign in to comment.