Skip to content

Commit aa9b3ec

Browse files
mark-i-mcamelidJoshua Nelsonphansch
committed
Apply suggestions from code review
Co-authored-by: Camelid <37223377+camelid@users.noreply.github.com> Co-authored-by: Joshua Nelson <joshua@yottadb.com> Co-authored-by: Phil Hansch <dev@phansch.net>
1 parent 69baf67 commit aa9b3ec

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

src/getting-started.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,11 @@ To run the compiler's UI test suite (the bulk of the test suite):
173173

174174
```
175175
# UI tests
176-
./x.py test --stage 1 src/test/ui [--keep-stage 1]
176+
# First build
177+
./x.py test --stage 1 src/test/ui
178+
179+
# Subsequent builds
180+
./x.py test --stage 1 src/test/ui --keep-stage 1
177181
```
178182

179183
This will build the compiler first, if needed.
@@ -215,7 +219,9 @@ stage 0.
215219
./x.py build --stage 0 src/libstd
216220
```
217221

218-
TODO: how to test?
222+
```sh
223+
./x.py test --stage 0 src/libstd
224+
```
219225

220226
### Building and Testing `rustdoc`
221227

@@ -235,11 +241,22 @@ even though the release version will use the full 2-stage build.
235241

236242
You can also use `./x.py check` here to do a fast check build.
237243

238-
TODO: how to test?
244+
Rustdoc has two types of tests: content tests and UI tests.
245+
246+
```sh
247+
# Content tests
248+
./x.py test --stage 1 src/test/rustdoc
249+
250+
# UI tests
251+
./x.py test --stage 1 src/test/rustdoc-ui
252+
253+
# Both at once
254+
./x.py test --stage 1 src/test/rustdoc*
255+
```
239256

240257
### Contributing code to other Rust projects
241258

242-
There are a bunch of other projects that one can contribute too outside of the
259+
There are a bunch of other projects that you can contribute to outside of the
243260
`rust-lang/rust` repo, including `clippy`, `miri`, `chalk`, and many others.
244261

245262
These repos might have their own contributing guidelines and procedures. Many
@@ -300,7 +317,7 @@ will be reviewed, approved, and merged. This includes most bug fixes,
300317
refactorings, and other user-invisible changes. The next few sections talk
301318
about exceptions to this rule.
302319

303-
Also, note that is perfectly acceptable to open WIP PRs or GitHub [Draft
320+
Also, note that it is perfectly acceptable to open WIP PRs or GitHub [Draft
304321
PRs][draft]. Some people prefer to do this so they can get feedback along the
305322
way or share their code with a collaborator. Others do this so they can utilize
306323
the CI to build and test their PR (e.g. if you are developing on a laptop).
@@ -370,7 +387,7 @@ changes. Crater runs can take a few days to complete.
370387
### Major Changes
371388

372389
The compiler team has a special process for large changes, whether or not they
373-
cause breakage. This process is call Major Change Proposal (MCP). MCP is a
390+
cause breakage. This process is called a Major Change Proposal (MCP). MCP is a
374391
relatively lightweight mechanism for getting feedback on large changes to the
375392
compiler (as opposed to a full RFC or a design meeting with the team).
376393

@@ -402,5 +419,6 @@ master.
402419
- [The t-compiler zulip][z]
403420
- [The compiler's documentation (rustdocs)](https://doc.rust-lang.org/nightly/nightly-rustc/)
404421
- [The Forge](https://forge.rust-lang.org/) has more documentation about various procedures.
422+
- `#contribute`, `#compiler`, and `#rustdoc` on [Discord](https://discord.gg/rust-lang).
405423

406424
TODO: am I missing any?

0 commit comments

Comments
 (0)