Skip to content

Commit 8d6459f

Browse files
JohnTitorJoshua Nelson
authored and
Joshua Nelson
committed
Update the "LLVM updates" section
1 parent dfe398b commit 8d6459f

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

src/backend/updating-llvm.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ Example PRs look like:
6767
## Feature updates
6868

6969
> Note that this information is as of the time of this writing <!-- date:
70-
2018-12 --> (December 2018). The process for updating LLVM changes with
70+
2021-04 --> (April 2021). The process for updating LLVM changes with
7171
practically all LLVM updates, so this may be out of date!
7272

7373
Unlike bugfixes, updating to pick up a new feature of LLVM typically requires a
7474
lot more work. This is where we can't reasonably cherry-pick commits backwards
7575
so we need to do a full update. There's a lot of stuff to do here, so let's go
7676
through each in detail.
7777

78-
1. Create a new branch in the rust-lang/llvm-project repository. This branch
78+
1. Create a new branch in the [rust-lang/llvm-project repository]. This branch
7979
should be named `rustc/a.b-yyyy-mm-dd` where `a.b` is the current version
8080
number of LLVM in-tree at the time of the branch and the remaining part is
8181
today's date. Move this branch to the commit in LLVM that you'd like, which
@@ -119,12 +119,12 @@ through each in detail.
119119
Ideally, build LLVM and test it on a few platforms:
120120

121121
* Linux
122-
* OSX
122+
* macOS
123123
* Windows
124124

125125
and afterwards run some docker containers that CI also does:
126126

127-
* `./src/ci/docker/run.sh wasm32-unknown`
127+
* `./src/ci/docker/run.sh wasm32`
128128
* `./src/ci/docker/run.sh arm-android`
129129
* `./src/ci/docker/run.sh dist-various-1`
130130
* `./src/ci/docker/run.sh dist-various-2`
@@ -136,15 +136,17 @@ through each in detail.
136136
`src/llvm-project` and will likely also change [`llvm-wrapper`] as well.
137137

138138
For prior art, previous LLVM updates look like
139-
[#55835](https://github.com/rust-lang/rust/pull/55835)
140-
[#47828](https://github.com/rust-lang/rust/pull/47828)
141139
[#62474](https://github.com/rust-lang/rust/pull/62474)
142-
[#62592](https://github.com/rust-lang/rust/pull/62592). Note that sometimes it's
140+
[#62592](https://github.com/rust-lang/rust/pull/62592)
141+
[#67759](https://github.com/rust-lang/rust/pull/67759)
142+
[#73526](https://github.com/rust-lang/rust/pull/73526)
143+
[#81451](https://github.com/rust-lang/rust/pull/81451). Note that sometimes it's
143144
easiest to land [`llvm-wrapper`] compatibility as a PR before actually updating
144145
`src/llvm-project`. This way while you're working through LLVM issues others
145146
interested in trying out the new LLVM can benefit from work you've done to
146147
update the C++ bindings.
147148

149+
[rust-lang/llvm-project repository]: https://github.com/rust-lang/llvm-project
148150
[`llvm-wrapper`]: https://github.com/rust-lang/rust/tree/master/compiler/rustc_llvm/llvm-wrapper
149151

150152
### Caveats and gotchas
@@ -155,10 +157,12 @@ keep in mind while going through them:
155157
* LLVM bugs are hard to find, don't hesitate to ask for help! Bisection is
156158
definitely your friend here (yes LLVM takes forever to build, yet bisection is
157159
still your friend)
158-
* If you've got general questions, @alexcrichton can help you out.
160+
* If you've got general questions, [wg-llvm] can help you out.
159161
* Creating branches is a privileged operation on GitHub, so you'll need someone
160162
with write access to create the branches for you most likely.
161163

164+
[wg-llvm]: https://rust-lang.zulipchat.com/#narrow/stream/187780-t-compiler.2Fwg-llvm
165+
162166
## New LLVM Release Updates
163167

164168
Updating to a new release of LLVM is very similar to the "feature updates"

0 commit comments

Comments
 (0)