|
1 | 1 | # Rust for Linux integration tests |
2 | 2 |
|
3 | | -[Rust for Linux](https://rust-for-linux.com/) (RfL) is an effort for adding support for the Rust programming |
4 | | -language into the Linux kernel. |
| 3 | +[Rust for Linux](https://rust-for-linux.com/) (RfL) is an effort for adding |
| 4 | +support for the Rust programming language into the Linux kernel. |
5 | 5 |
|
6 | 6 | ## Building Rust for Linux in CI |
7 | 7 |
|
8 | | -Rust for Linux builds as part of the suite of bors tests that run before a pull request |
9 | | -is merged. |
| 8 | +Rust for Linux builds as part of the suite of bors tests that run before a pull |
| 9 | +request is merged. |
10 | 10 |
|
11 | | -The workflow builds a stage1 sysroot of the Rust compiler, downloads the Linux kernel, and tries to compile several Rust for Linux drivers and examples using this sysroot. RfL uses several unstable compiler/language features, therefore this workflow notifies us if a given compiler change would break it. |
| 11 | +The workflow builds a stage1 sysroot of the Rust compiler, downloads the Linux |
| 12 | +kernel, and tries to compile several Rust for Linux drivers and examples using |
| 13 | +this sysroot. RfL uses several unstable compiler/language features, therefore |
| 14 | +this workflow notifies us if a given compiler change would break it. |
12 | 15 |
|
13 | | -If you are worried that a pull request might break the Rust for Linux builder and want |
14 | | -to test it out before submitting it to the bors queue, simply add this line to |
15 | | -your PR description: |
| 16 | +If you are worried that a pull request might break the Rust for Linux builder |
| 17 | +and want to test it out before submitting it to the bors queue, simply add this |
| 18 | +line to your PR description: |
16 | 19 |
|
17 | 20 | > try-job: x86_64-rust-for-linux |
18 | 21 |
|
19 | | -Then when you `@bors try` it will pick the job that builds the Rust for Linux integration. |
| 22 | +Then when you `@bors try` it will pick the job that builds the Rust for Linux |
| 23 | +integration. |
20 | 24 |
|
21 | 25 | ## What to do in case of failure |
22 | 26 |
|
23 | | -Currently, we use the following unofficial policy for handling failures caused by a change breaking the RfL integration: |
| 27 | +Currently, we use the following unofficial policy for handling failures caused |
| 28 | +by a change breaking the RfL integration: |
24 | 29 |
|
25 | 30 | - If the breakage was unintentional, then fix the PR. |
26 | | -- If the breakage was intentional, then let [RFL][rfl-ping] know and discuss what will the kernel need to change. |
| 31 | +- If the breakage was intentional, then let [RFL][rfl-ping] know and discuss |
| 32 | + what will the kernel need to change. |
27 | 33 | - If the PR is urgent, then disable the test temporarily. |
28 | | - - If the PR can wait a few days, then wait for RFL maintainers to provide a new Linux kernel commit hash with the needed changes done, and apply it to the PR, which would confirm the changes work. |
| 34 | + - If the PR can wait a few days, then wait for RFL maintainers to provide a |
| 35 | + new Linux kernel commit hash with the needed changes done, and apply it to |
| 36 | + the PR, which would confirm the changes work. |
29 | 37 |
|
30 | | -If something goes wrong with the workflow, you can ping the [Rust for Linux][rfl-ping] ping group to ask for help. |
| 38 | +If something goes wrong with the workflow, you can ping the [Rust for |
| 39 | +Linux][rfl-ping] ping group to ask for help. |
| 40 | + |
| 41 | +```text |
| 42 | +@rustbot ping rfl |
| 43 | +``` |
31 | 44 |
|
32 | 45 | [rfl-ping]: ../notification-groups/rust-for-linux.md |
0 commit comments