Skip to content

Commit 2bb8a0d

Browse files
committed
sembr tests/crater.md
1 parent 9542d61 commit 2bb8a0d

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

src/tests/crater.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,46 @@
11
# Crater
22

33
[Crater](https://github.com/rust-lang/crater) is a tool for compiling and
4-
running tests for _every_ crate on [crates.io](https://crates.io) (and a few on
5-
GitHub). It is mainly used for checking the extent of breakage when implementing
4+
running tests for _every_ crate on [crates.io](https://crates.io) (and a few on GitHub).
5+
It is mainly used for checking the extent of breakage when implementing
66
potentially breaking changes and ensuring lack of breakage by running beta vs
77
stable compiler versions.
88

99
## When to run Crater
1010

1111
You should request a Crater run if your PR makes large changes to the compiler
12-
or could cause breakage. If you are unsure, feel free to ask your PR's reviewer.
12+
or could cause breakage.
13+
If you are unsure, feel free to ask your PR's reviewer.
1314

1415
## Requesting Crater Runs
1516

1617
The Rust team maintains a few machines that can be used for Crater runs
17-
on the changes introduced by a PR. If your PR needs a Crater run, leave a
18-
comment for the triage team in the PR thread. Please inform the team whether you
19-
require a "check-only" Crater run, a "build only" Crater run, or a
20-
"build-and-test" Crater run. The difference is primarily in time;
21-
if you're not sure, go for the build-and-test run. If
18+
on the changes introduced by a PR.
19+
If your PR needs a Crater run, leave a comment for the triage team in the PR thread.
20+
Please inform the team whether you
21+
require a "check-only" Crater run, a "build only" Crater run, or a "build-and-test" Crater run.
22+
The difference is primarily in time;
23+
if you're not sure, go for the build-and-test run.
24+
If
2225
making changes that will only have an effect at compile-time (e.g., implementing
2326
a new trait), then you only need a check run.
2427

25-
Your PR will be enqueued by the triage team and the results will be posted when
26-
they are ready. Check runs will take around ~3-4 days, and the other two taking
27-
5-6 days on average.
28+
Your PR will be enqueued by the triage team and the results will be posted when they are ready.
29+
Check runs will take around ~3-4 days, and the other two taking 5-6 days on average.
2830

29-
While Crater is really useful, it is also important to be aware of a few
30-
caveats:
31+
While Crater is really useful, it is also important to be aware of a few caveats:
3132

32-
- Not all code is on crates.io! There is a lot of code in repos on GitHub and
33-
elsewhere. Also, companies may not wish to publish their code. Thus, a
34-
successful Crater run does not mean there will be no
33+
- Not all code is on crates.io!
34+
There is a lot of code in repos on GitHub and elsewhere.
35+
Also, companies may not wish to publish their code.
36+
Thus, a successful Crater run does not mean there will be no
3537
breakage; you still need to be careful.
3638

37-
- Crater only runs Linux builds on x86_64. Thus, other architectures and
38-
platforms are not tested. Critically, this includes Windows.
39+
- Crater only runs Linux builds on x86_64. Thus, other architectures and platforms are not tested.
40+
Critically, this includes Windows.
3941

40-
- Many crates are not tested. This could be for a lot of reasons, including that
42+
- Many crates are not tested.
43+
This could be for a lot of reasons, including that
4144
the crate doesn't compile any more (e.g. used old nightly features), has
4245
broken or flaky tests, requires network access, or other reasons.
4346

0 commit comments

Comments
 (0)