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.

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

Document alt builds #289

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
- [Bisection boundaries](boundaries.md)
- [Rustup toolchains](rustup.md)
- [Git bisect a custom build](git-bisect.md)
- [Alt builds](alt.md)
- [Examples](examples/index.md)
- [Checking diagnostics](examples/diagnostics.md)
- [Scripting on Windows](examples/windows-scripting.md)
Expand Down
29 changes: 29 additions & 0 deletions guide/src/alt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Alt builds

Each commit also generates what are called "alt" builds.
These are builds of rustc with some different options set.
As of August 2023, these include:

* `rust.parallel-compiler`
* `llvm.assertions`
* `rust.verify-llvm-ir`

For more information on these settings, see the [`config.toml` docs].
These alt settings are defined in [`ci/run.sh`].

Alt builds are only available for a few targets.
Look for the `-alt` builds in [`ci.yml`].

This can be useful if you are bisecting an LLVM issue.
With LLVM assertions enabled, alt builds have checks that can help identify broken assumptions.

Alt builds are only made for commit builds, and not nightly releases.
You will need to specify `--by-commit` (or use a hash in the `--start` or `--end` flags) to only use commit builds.

```sh
cargo bisect-rustc --alt --by-commit
```

[`config.toml` docs]: https://github.com/rust-lang/rust/blob/master/config.example.toml
[`ci/run.sh`]: https://github.com/rust-lang/rust/blob/c0b6ffaaea3ebdf5f7a58fc4cf7ee52c91077fb9/src/ci/run.sh#L99-L105
[`ci.yml`]: https://github.com/rust-lang/rust/blob/HEAD/src/ci/github-actions/ci.yml