Skip to content

docs: the name included in the toolchain identifier is not a branch name #843

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

Merged
Mark-Simulacrum merged 1 commit into from
Jul 20, 2026
Merged

docs: the name included in the toolchain identifier is not a branch name #843

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
6 changes: 4 additions & 2 deletions docs/bot-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ parents (both should be merge commits by bors):

You must prefix the start commit with `master#`, and the end commit with
`try#`, and both of them should be written with the full 40-chars hash.
(See [specifying-toolchains](#specifying-toolchains) for more details on that syntax.)

Then you need to choose the [experiment mode you want to
use][h-experiment-modes] and type up the command in your GitHub PR:
Expand Down Expand Up @@ -148,8 +149,9 @@ that capability.
### Specifying Toolchains

Crater allows some configurations to the toolchains used in an experiment.
You can specify a toolchain using a rustup name or `branch#sha`, and use the
following flags:
You can specify a toolchain using a rustup name or `channel#sha` where `channel`
can be `master` for regular main branch toolchains or `try` for try builds.
On top of that, you can use the following flags:
* `+rustflags={flags}`: sets the `RUSTFLAGS` environment variable to `{flags}` when
building with this toolchain, e.g. `+rustflags=-Zverbose`
* `+cargoflags={flags}`: appends the given `{flags}` to the Cargo command specified
Expand Down