Skip to content

Commit 7345cee

Browse files
authored
move references down to avoid clutter (rust-lang#1420)
Also, make link to upstream llvm repo clickable
1 parent 81334fc commit 7345cee

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Diff for: src/backend/updating-llvm.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ the branch we're already using. The steps for this are:
4343
1. Make sure the bugfix is in upstream LLVM.
4444
2. Identify the branch that rustc is currently using. The `src/llvm-project`
4545
submodule is always pinned to a branch of the
46-
[rust-lang/llvm-project](https://github.com/rust-lang/llvm-project) repository.
46+
[rust-lang/llvm-project repository].
4747
3. Fork the rust-lang/llvm-project repository
4848
4. Check out the appropriate branch (typically named `rustc/a.b-yyyy-mm-dd`)
4949
5. Cherry-pick the upstream commit onto the branch
@@ -146,9 +146,6 @@ easiest to land [`llvm-wrapper`] compatibility as a PR before actually updating
146146
interested in trying out the new LLVM can benefit from work you've done to
147147
update the C++ bindings.
148148

149-
[rust-lang/llvm-project repository]: https://github.com/rust-lang/llvm-project
150-
[`llvm-wrapper`]: https://github.com/rust-lang/rust/tree/master/compiler/rustc_llvm/llvm-wrapper
151-
152149
### Caveats and gotchas
153150

154151
Ideally the above instructions are pretty smooth, but here's some caveats to
@@ -161,8 +158,6 @@ keep in mind while going through them:
161158
* Creating branches is a privileged operation on GitHub, so you'll need someone
162159
with write access to create the branches for you most likely.
163160

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

168163
Updating to a new release of LLVM is very similar to the "feature updates"
@@ -172,7 +167,7 @@ section above is generally around branch naming. The sequence of events
172167
typically looks like:
173168

174169
1. LLVM announces that its latest release version has branched. This will show
175-
up as a branch in https://github.com/llvm/llvm-project typically named
170+
up as a branch in the [llvm/llvm-project repository] typically named
176171
`release/$N.x` where `$N` is the version of LLVM that's being released.
177172

178173
2. We then follow the "feature updates" section above to create a new branch of
@@ -192,3 +187,8 @@ typically looks like:
192187
to create a new branch in the rust-lang/llvm-project repository, this time
193188
with a new date. The commit history should look much cleaner as just a few
194189
Rust-specific commits stacked on top of stock LLVM's release branch.
190+
191+
[rust-lang/llvm-project repository]: https://github.com/rust-lang/llvm-project
192+
[llvm/llvm-project repository]: https://github.com/llvm/llvm-project
193+
[`llvm-wrapper`]: https://github.com/rust-lang/rust/tree/master/compiler/rustc_llvm/llvm-wrapper
194+
[wg-llvm]: https://rust-lang.zulipchat.com/#narrow/stream/187780-t-compiler.2Fwg-llvm

0 commit comments

Comments
 (0)