Skip to content

Commit 60bc9ab

Browse files
authored
Spelling: Rename rust to Rust (rust-lang#1288)
1 parent a10c5be commit 60bc9ab

19 files changed

+35
-35
lines changed

src/about-this-guide.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ please see the corresponding [subsection on writing documentation in this guide]
5959
You might also find the following sites useful:
6060

6161
- [rustc API docs] -- rustdoc documentation for the compiler
62-
- [Forge] -- contains documentation about rust infrastructure, team procedures, and more
63-
- [compiler-team] -- the home-base for the rust compiler team, with description
62+
- [Forge] -- contains documentation about Rust infrastructure, team procedures, and more
63+
- [compiler-team] -- the home-base for the Rust compiler team, with description
6464
of the team procedures, active working groups, and the team calendar.
6565
- [std-dev-guide] -- a similar guide for developing the standard library.
6666

src/backend/codegen.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Code generation or "codegen" is the part of the compiler that actually
44
generates an executable binary. Usually, rustc uses LLVM for code generation;
55
there is also support for [Cranelift]. The key is that rustc doesn't implement
6-
codegen itself. It's worth noting, though, that in the rust source code, many
6+
codegen itself. It's worth noting, though, that in the Rust source code, many
77
parts of the backend have `codegen` in their names (there are no hard
88
boundaries).
99

src/backend/monomorph.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- toc -->
44

5-
As you probably know, rust has a very expressive type system that has extensive
5+
As you probably know, Rust has a very expressive type system that has extensive
66
support for generic types. But of course, assembly is not generic, so we need
77
to figure out the concrete types of all the generics before the code can
88
execute.
@@ -23,7 +23,7 @@ The result is fast programs, but it comes at the cost of compile time (creating
2323
all those copies can take a while) and binary size (all those copies might take
2424
a lot of space).
2525

26-
Monomorphization is the first step in the backend of the rust compiler.
26+
Monomorphization is the first step in the backend of the Rust compiler.
2727

2828
## Collection
2929

src/building/bootstrapping.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ bootstrapping the compiler.
110110
When you use the bootstrap system, you'll call it through `x.py`.
111111
However, most of the code lives in `src/bootstrap`.
112112
`bootstrap` has a difficult problem: it is written in Rust, but yet it is run
113-
before the rust compiler is built! To work around this, there are two
113+
before the Rust compiler is built! To work around this, there are two
114114
components of bootstrap: the main one written in rust, and `bootstrap.py`.
115115
`bootstrap.py` is what gets run by `x.py`. It takes care of downloading the
116116
`stage0` compiler, which will then build the bootstrap binary written in

src/building/compiler-documenting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,6 @@ documentation for internal compiler items will also be built.
5050

5151
### Compiler Documentation
5252

53-
The documentation for the rust components are found at [rustc doc].
53+
The documentation for the Rust components are found at [rustc doc].
5454

5555
[rustc doc]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/

src/building/how-to-build-and-run.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -120,15 +120,15 @@ Options:
120120
--on-fail CMD command to run on failure
121121
--stage N stage to build
122122
--keep-stage N stage to keep without recompiling
123-
--src DIR path to the root of the rust checkout
123+
--src DIR path to the root of the Rust checkout
124124
-j, --jobs JOBS number of jobs to run in parallel
125125
-h, --help print this help message
126126
```
127127

128128
For hacking, often building the stage 1 compiler is enough, which saves a lot
129129
of time. But for final testing and release, the stage 2 compiler is used.
130130

131-
`./x.py check` is really fast to build the rust compiler.
131+
`./x.py check` is really fast to build the Rust compiler.
132132
It is, in particular, very useful when you're doing some kind of
133133
"type-based refactoring", like renaming a method, or changing the
134134
signature of some function.
@@ -150,7 +150,7 @@ What this command does is the following:
150150
- Build `std` using the stage1 compiler (cannot use incremental)
151151

152152
This final product (stage1 compiler + libs built using that compiler)
153-
is what you need to build other rust programs (unless you use `#![no_std]` or
153+
is what you need to build other Rust programs (unless you use `#![no_std]` or
154154
`#![no_core]`).
155155

156156
The command includes the `-i` switch which enables incremental compilation.

src/building/suggested.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ do not get shared. They will still be cloned multiple times.
199199

200200
[worktrees]: https://git-scm.com/docs/git-worktree
201201

202-
Given you are inside the root directory for your rust repository, you can
202+
Given you are inside the root directory for your Rust repository, you can
203203
create a "linked working tree" in a new "rust2" directory by running
204204
the following command:
205205

src/compiler-src.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ crates, just like a normal Rust crate.
7676

7777
One final thing: [`src/llvm-project`] is a submodule for our fork of LLVM.
7878
During bootstrapping, LLVM is built and the [`compiler/rustc_llvm`] crate
79-
contains rust wrappers around LLVM (which is written in C++), so that the
79+
contains Rust wrappers around LLVM (which is written in C++), so that the
8080
compiler can interface with it.
8181

8282
Most of this book is about the compiler, so we won't have any further
@@ -183,7 +183,7 @@ from `src/tools/`, such as [`tidy`] or [`compiletest`].
183183
## Other
184184

185185
There are a lot of other things in the `rust-lang/rust` repo that are related
186-
to building a full rust distribution. Most of the time you don't need to worry
186+
to building a full Rust distribution. Most of the time you don't need to worry
187187
about them.
188188

189189
These include:

src/compiletest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ function found in the `TestCx` implementation block, located in
178178
}
179179

180180
fn check_correct_failure_status(&self, proc_res: &ProcRes) {
181-
- // The value the rust runtime returns on failure
181+
- // The value the Rust runtime returns on failure
182182
- const RUST_ERR: i32 = 101;
183183
- if proc_res.status.code() != Some(RUST_ERR) {
184184
+ let expected_status = Some(self.props.failure_status);

src/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ is modified to move the files from the specified directory to the tool repo root
214214

215215
A `subtree pull` takes all changes since the last `subtree pull`
216216
from the tool repo and adds these commits to the rustc repo along with a merge commit that moves
217-
the tool changes into the specified directory in the rust repository.
217+
the tool changes into the specified directory in the Rust repository.
218218

219219
It is recommended that you always do a push first and get that merged to the tool master branch.
220220
Then, when you do a pull, the merge works without conflicts.

src/crates-io.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# crates.io Dependencies
22

3-
The rust compiler supports building with some dependencies from `crates.io`.
3+
The Rust compiler supports building with some dependencies from `crates.io`.
44
For example, `log` and `env_logger` come from `crates.io`.
55

66
In general, you should avoid adding dependencies to the compiler for several

src/diagnostics/diagnostic-items.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ reference [*How To Use Diagnostic Items*](#how-to-use-diagnostic-items).
2929

3030
A new diagnostic item can be added with these two steps:
3131

32-
1. Find the target item inside the rust repo. Now add the diagnostic item as a string via the
32+
1. Find the target item inside the Rust repo. Now add the diagnostic item as a string via the
3333
`rustc_diagnostic_item` attribute. This can sometimes cause compilation errors while running
3434
tests. These errors can be avoided by using the `cfg_attr` attribute with the `not(test)`
3535
condition (it's fine adding then for all `rustc_diagnostic_item` attributes as a preventive

src/macro-expansion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ handle names defined _within a macro_. In particular, a hygienic macro system
216216
prevents errors due to names introduced within a macro. Rust macros are hygienic
217217
in that they do not allow one to write the sorts of bugs above.
218218
219-
At a high level, hygiene within the rust compiler is accomplished by keeping
219+
At a high level, hygiene within the Rust compiler is accomplished by keeping
220220
track of the context where a name is introduced and used. We can then
221221
disambiguate names based on that context. Future iterations of the macro system
222222
will allow greater control to the macro author to use that context. For example,

src/overview.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
This chapter is about the overall process of compiling a program -- how
66
everything fits together.
77

8-
The rust compiler is special in two ways: it does things to your code that
8+
The Rust compiler is special in two ways: it does things to your code that
99
other compilers don't do (e.g. borrow checking) and it has a lot of
1010
unconventional implementation choices (e.g. queries). We will talk about these
1111
in turn in this chapter, and in the rest of the guide, we will look at all the
@@ -225,7 +225,7 @@ interned.
225225

226226
### Queries
227227

228-
The first big implementation choice is the _query_ system. The rust compiler
228+
The first big implementation choice is the _query_ system. The Rust compiler
229229
uses a query system which is unlike most textbook compilers, which are
230230
organized as a series of passes over the code that execute sequentially. The
231231
compiler does this to make incremental compilation possible -- that is, if the

src/test-implementation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- toc -->
44

5-
Today, rust programmers rely on a built in attribute called `#[test]`. All
5+
Today, Rust programmers rely on a built in attribute called `#[test]`. All
66
you have to do is mark a function as a test and include some asserts like so:
77

88
```rust,ignore

src/tests/intro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ start a bash shell in the container, run `src/ci/docker/run.sh --dev <IMAGE>`
149149
where `<IMAGE>` is one of the directory names in `src/ci/docker` (for example
150150
`x86_64-gnu` is a fairly standard Ubuntu environment).
151151

152-
The docker script will mount your local rust source tree in read-only mode,
152+
The docker script will mount your local Rust source tree in read-only mode,
153153
and an `obj` directory in read-write mode. All of the compiler artifacts will
154154
be stored in the `obj` directory. The shell will start out in the `obj`
155155
directory. From there, you can run `../src/ci/run.sh` which will run the build
@@ -301,7 +301,7 @@ or could cause breakage. If you are unsure, feel free to ask your PR's reviewer.
301301

302302
### Requesting Crater Runs
303303

304-
The rust team maintains a few machines that can be used for running crater runs
304+
The Rust team maintains a few machines that can be used for running crater runs
305305
on the changes introduced by a PR. If your PR needs a crater run, leave a
306306
comment for the triage team in the PR thread. Please inform the team whether
307307
you require a "check-only" crater run, a "build only" crater run, or a

src/tests/running.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ may invoke `x.py` with the `--test-args` option:
124124
./x.py test src/test/ui --test-args issue-1234
125125
```
126126

127-
Under the hood, the test runner invokes the standard rust test runner
127+
Under the hood, the test runner invokes the standard Rust test runner
128128
(the same one you get with `#[test]`), so this command would wind up
129129
filtering for tests that include "issue-1234" in the name. (Thus
130130
`--test-args` is a good way to run a collection of related tests.)

src/ty.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ different [`Span`s][span] (locations).
4040
[span]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_span/struct.Span.html
4141

4242
**Example: `fn foo(x: &u32) -> &u32`** In addition, HIR might have information left out. This type
43-
`&u32` is incomplete, since in the full rust type there is actually a lifetime, but we didn’t need
43+
`&u32` is incomplete, since in the full Rust type there is actually a lifetime, but we didn’t need
4444
to write those lifetimes. There are also some elision rules that insert information. The result may
4545
look like `fn foo<'a>(x: &'a u32) -> &'a u32`.
4646

src/walkthrough.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<!-- toc -->
44

5-
There are _a lot_ of ways to contribute to the rust compiler, including fixing
5+
There are _a lot_ of ways to contribute to the Rust compiler, including fixing
66
bugs, improving performance, helping design features, providing feedback on
77
existing features, etc. This chapter does not claim to scratch the surface.
88
Instead, it walks through the design and implementation of a new feature. Not
@@ -38,7 +38,7 @@ fn main() {
3838
So basically, the `$(pat)?` matcher in the macro means "this pattern can occur
3939
0 or 1 times", similar to other regex syntaxes.
4040

41-
There were a number of steps to go from an idea to stable rust feature. Here is
41+
There were a number of steps to go from an idea to stable Rust feature. Here is
4242
a quick list. We will go through each of these in order below. As I mentioned
4343
before, not all of these are needed for every type of contribution.
4444

@@ -55,9 +55,9 @@ before, not all of these are needed for every type of contribution.
5555
feature on the nightly compiler and in `std`, there may be additional
5656
feedback about design choice that might be adjusted. This particular feature
5757
went [through][impl2] a [number][impl3] of [iterations][impl4].
58-
- **Stabilization** When your feature has baked enough, a rust team member may
58+
- **Stabilization** When your feature has baked enough, a Rust team member may
5959
[propose to stabilize it][merge]. If there is consensus, this is done.
60-
- **Relax** Your feature is now a stable rust feature!
60+
- **Relax** Your feature is now a stable Rust feature!
6161

6262
[prerfc]: https://internals.rust-lang.org/t/pre-rfc-at-most-one-repetition-macro-patterns/6557
6363
[rfc]: https://github.com/rust-lang/rfcs/pull/2298
@@ -70,7 +70,7 @@ before, not all of these are needed for every type of contribution.
7070
## Pre-RFC and RFC
7171

7272
> NOTE: In general, if you are not proposing a _new_ feature or substantial
73-
> change to rust or the ecosystem, you don't need to follow the RFC process.
73+
> change to Rust or the ecosystem, you don't need to follow the RFC process.
7474
> Instead, you can just jump to [implementation](#impl).
7575
>
7676
> You can find the official guidelines for when to open an RFC [here][rfcwhen].
@@ -79,7 +79,7 @@ before, not all of these are needed for every type of contribution.
7979

8080
An RFC is a document that describes the feature or change you are proposing in
8181
detail. Anyone can write an RFC; the process is the same for everyone,
82-
including rust team members.
82+
including Rust team members.
8383

8484
To open an RFC, open a PR on the
8585
[rust-lang/rfcs](https://github.com/rust-lang/rfcs) repo on GitHub. You can
@@ -122,7 +122,7 @@ itself to reflect the course of the discussion (e.g. new alternatives or prior
122122
work may be added or you may decide to change parts of the proposal itself).
123123

124124
In the end, when the discussion seems to reach a consensus and die down a bit,
125-
a rust team member may propose to move to "final comment period" (FCP) with one
125+
a Rust team member may propose to move to "final comment period" (FCP) with one
126126
of three possible dispositions. This means that they want the other members of
127127
the appropriate teams to review and comment on the RFC. More discussion may
128128
ensue, which may result in more changes or unresolved questions being added. At
@@ -137,7 +137,7 @@ disposition is adopted. Here are the three possible dispositions:
137137
This is not a reflection on you, but rather a community decision that rust
138138
will go a different direction.
139139
- _Postpone_: there is interest in going this direction but not at the moment.
140-
This happens most often because the appropriate rust team doesn't have the
140+
This happens most often because the appropriate Rust team doesn't have the
141141
bandwidth to shepherd the feature through the process to stabilization. Often
142142
this is the case when the feature doesn't fit into the team's roadmap.
143143
Postponed ideas may be revisited later.
@@ -181,7 +181,7 @@ gate is removed when the feature is stabilized.
181181
make your changes/improvements.
182182

183183
When you open a PR on the [rust-lang/rust], a bot will assign your PR to a
184-
review. If there is a particular rust team member you are working with, you can
184+
review. If there is a particular Rust team member you are working with, you can
185185
request that reviewer by leaving a comment on the thread with `r?
186186
@reviewer-github-id` (e.g. `r? @eddyb`). If you don't know who to request,
187187
don't request anyone; the bot will assign someone automatically based on which files you changed.
@@ -224,7 +224,7 @@ be proposed and unresolved questions may become resolved. Updates/changes go
224224
through the same process for implementing any other changes, as described
225225
above (i.e. submit a PR, go through review, wait for `@bors`, etc).
226226

227-
Some changes may be major enough to require an FCP and some review by rust team
227+
Some changes may be major enough to require an FCP and some review by Rust team
228228
members.
229229

230230
For the `?` macro feature, we went through a few different iterations after the

0 commit comments

Comments
 (0)