Skip to content

Commit 11f2641

Browse files
committed
sembr src/offload/contributing.md
1 parent a427d2e commit 11f2641

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

src/offload/contributing.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
# Contributing
22

3-
Contributions are always welcome. This project is experimental, so the documentation and code are likely incomplete. Please ask on [Zulip](https://rust-lang.zulipchat.com/#narrow/channel/422870-t-compiler.2Fgpgpu-backend) (preferred) or the Rust Community Discord for help if you get stuck or if our documentation is unclear.
3+
Contributions are always welcome.
4+
This project is experimental, so the documentation and code are likely incomplete.
5+
Please ask on [Zulip](https://rust-lang.zulipchat.com/#narrow/channel/422870-t-compiler.2Fgpgpu-backend) (preferred) or the Rust Community Discord for help if you get stuck or if our documentation is unclear.
46

5-
We generally try to automate as much of the compilation process as possible for users. However, as a contributor it might sometimes be easier to directly rewrite and compile the LLVM-IR modules (.ll) to quickly iterate on changes, without needing to repeatedly recompile rustc. For people familiar with LLVM we therefore have the shell script below. Only when you are then happy with the IR changes you can work on updating rustc to generate the new, desired output.
7+
We generally try to automate as much of the compilation process as possible for users.
8+
However, as a contributor it might sometimes be easier to directly rewrite and compile the LLVM-IR modules (.ll) to quickly iterate on changes, without needing to repeatedly recompile rustc.
9+
For people familiar with LLVM we therefore have the shell script below.
10+
Only when you are then happy with the IR changes you can work on updating rustc to generate the new, desired output.
611

712
```sh
813
set -e
@@ -29,4 +34,6 @@ opt lib.ll -o lib.bc
2934
LIBOMPTARGET_INFO=-1 OFFLOAD_TRACK_ALLOCATION_TRACES=true ./a.out
3035
```
3136

32-
Please update the `<path>` placeholders on the `clang-linker-wrapper` invocation. You will likely also need to adjust the library paths. See the linked usage section for details: [usage](usage.md#compile-instructions)
37+
Please update the `<path>` placeholders on the `clang-linker-wrapper` invocation.
38+
You will likely also need to adjust the library paths.
39+
See the linked usage section for details: [usage](usage.md#compile-instructions)

0 commit comments

Comments
 (0)