Skip to content

Commit 07b5693

Browse files
camelidJoshua Nelson
authored and
Joshua Nelson
committed
Update some out-of-date information
1 parent 033a1ea commit 07b5693

File tree

5 files changed

+18
-20
lines changed

5 files changed

+18
-20
lines changed

src/appendix/humorust.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ enlightening?
1010
- [Rust Koans](https://users.rust-lang.org/t/rust-koans/2408)
1111
- [`break rust;`](https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=0ab2bd6a9d722e0f05a95e2a5dcf89cc)
1212
- [The Nomicon Intro](https://doc.rust-lang.org/stable/nomicon/)
13-
- [`rustc-ty` renaming punfest](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rustc-ty.20naming.20bikeshed.20.2F.20punfest.20(was.3A.20design.20meeting.202.2E.2E.2E/near/189906455 )
13+
- [`rustc-ty` renaming punfest](https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rustc-ty.20naming.20bikeshed.20.2F.20punfest.20\(was.3A.20design.20meeting.202.2E.2E.2E/near/189906455)

src/backend/updating-llvm.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ Example PRs look like:
6666

6767
## Feature updates
6868

69-
> Note that this is all information as applies to the current day in age. This
70-
> process for updating LLVM changes with practically all LLVM updates, so this
71-
> may be out of date!
69+
> Note that this information is as of the time of this writing (December 2018
70+
> <!-- date: 2018-12 -->. The process for updating LLVM changes with practically
71+
> 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

src/building/new-target.md

+2-8
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,22 @@ relevant to your desired goal.
88

99
For very new targets, you may need to use a different fork of LLVM
1010
than what is currently shipped with Rust. In that case, navigate to
11-
the `src/llvm_project` git submodule (you might need to run `x.py
11+
the `src/llvm-project` git submodule (you might need to run `x.py
1212
check` at least once so the submodule is updated), check out the
1313
appropriate commit for your fork, then commit that new submodule
1414
reference in the main Rust repository.
1515

1616
An example would be:
1717

1818
```
19-
cd src/llvm_project
19+
cd src/llvm-project
2020
git remote add my-target-llvm some-llvm-repository
2121
git checkout my-target-llvm/my-branch
2222
cd ..
2323
git add llvm_target
2424
git commit -m 'Use my custom LLVM'
2525
```
2626

27-
If you have a local LLVM checkout that is already built, you *may* be
28-
able to configure Rust to treat your build as the [system
29-
LLVM][sysllvm] to avoid redundant builds.
30-
31-
[sysllvm]: ./suggested.md#skipping-llvm-build
32-
3327
## Creating a target specification
3428

3529
You should start with a target JSON file. You can see the specification

src/getting-started.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ recommend trying to build on a Raspberry Pi :P
7979

8080
Building the compiler takes more than half an hour on my moderately powerful
8181
laptop. The first time you build the compiler, LLVM will also be built unless
82-
you use your system's LLVM ([see below][configsec]).
82+
you use CI-built LLVM ([see below][configsec]).
8383

8484
[configsec]: #configuring-the-compiler
8585

@@ -123,17 +123,17 @@ The compiler has a configuration file which contains a ton of settings. We will
123123
provide some recommendations here that should work for most, but [check out
124124
this chapter for more info][config].
125125

126-
[config]: ./building/how-to-build-and-run.html#create-a-configtoml
126+
[config]: ./building/how-to-build-and-run.md#create-a-configtoml
127127

128128
In the top level of the repo:
129129

130-
```sh
130+
```console
131131
$ x.py setup
132132
```
133133

134134
This will walk you through an interactive setup for x.py that looks like this:
135135

136-
```
136+
```console
137137
$ x.py setup
138138
Welcome to the Rust project! What do you want to do with x.py?
139139
a) Contribute to the standard library
@@ -150,11 +150,15 @@ To get started, try one of the following commands:
150150
For more suggestions, see https://rustc-dev-guide.rust-lang.org/building/suggested.html
151151
```
152152

153-
You may also want to set up [system LLVM][sysllvm] to avoid building LLVM from source.
153+
Note that by default, `x.py setup` will use CI-built LLVM if available for your
154+
platform so that you don't need to build LLVM in addition to building the
155+
compiler. In some circumstances, such as when updating the version of LLVM used
156+
by `rustc`, you may want to temporarily disable this feature. See the ["Updating
157+
LLVM"] for more.
154158

155-
[sysllvm]: ./building/suggested.html#skipping-llvm-build
159+
["Updating LLVM"]: https://rustc-dev-guide.rust-lang.org/backend/updating-llvm.html?highlight=download-ci-llvm#feature-updates
156160

157-
### `./x.py` Intro
161+
### x.py Intro
158162

159163
`rustc` is a _bootstrapping_ compiler, which means that it is written in Rust
160164
and thus needs to be compiled by itself. So where do you

src/traits/chalk.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ and designs for the trait system.
3434

3535
**rustc**. Once we are happy with the logical rules, we proceed to
3636
implementing them in rustc. We map our struct, trait, and impl declarations
37-
into logical inference rules in the [lowering module in rustc](./lowering-module.md).
37+
into logical inference rules in the lowering module in rustc.
3838

3939
[chalk]: https://github.com/rust-lang/chalk
4040
[rustc_traits]: https://github.com/rust-lang/rust/tree/master/compiler/rustc_traits

0 commit comments

Comments
 (0)