@@ -193,7 +193,7 @@ it can be found [here][rctd].
193
193
As a developer to this repository, you don't have to treat the following external projects
194
194
differently from other crates that are directly in this repo:
195
195
196
- * none so far, see https://github.com/rust-lang/rust/issues/70651 for more info
196
+ * Clippy
197
197
198
198
They are just regular files and directories. This is in contrast to ` submodule ` dependencies
199
199
(see below for those). Only tool authors will actually use any operations here.
@@ -247,15 +247,14 @@ git subtree add -P src/tools/clippy https://github.com/rust-lang/rust-clippy.git
247
247
This will create a new commit, which you may not rebase under any circumstances! Delete the commit
248
248
and redo the operation if you need to rebase.
249
249
250
- Now you're done, the ` src/tools/clippy ` directory behaves as if clippy were part of the rustc
250
+ Now you're done, the ` src/tools/clippy ` directory behaves as if Clippy were part of the rustc
251
251
monorepo, so no one but you (or others that synchronize subtrees) actually needs to use ` git subtree ` .
252
252
253
253
254
254
### External Dependencies (submodules)
255
255
256
256
Currently building Rust will also build the following external projects:
257
257
258
- * [ clippy] ( https://github.com/rust-lang/rust-clippy )
259
258
* [ miri] ( https://github.com/rust-lang/miri )
260
259
* [ rustfmt] ( https://github.com/rust-lang/rustfmt )
261
260
* [ rls] ( https://github.com/rust-lang/rls/ )
@@ -393,10 +392,18 @@ You can find documentation style guidelines in [RFC 1574][rfc1574].
393
392
394
393
[ rfc1574 ] : https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
395
394
396
- In many cases, you don't need a full ` ./x.py doc ` . You can use ` rustdoc ` directly
397
- to check small fixes. For example, ` rustdoc src/doc/reference.md ` will render
398
- reference to ` doc/reference.html ` . The CSS might be messed up, but you can
399
- verify that the HTML is right.
395
+ In many cases, you don't need a full ` ./x.py doc ` , which will build the entire
396
+ stage 2 compiler and compile the various books published on
397
+ [ doc.rust-lang.org] . When updating documentation for the standard library,
398
+ first try ` ./x.py doc --stage 0 src/libstd ` . If that fails, or if you need to
399
+ see the output from the latest version of ` rustdoc ` , use ` --stage 1 ` instead of
400
+ ` --stage 0 ` . Results should appear in ` build/$TARGET/crate-docs ` .
401
+
402
+ [ doc.rust-lang.org ] : htts://doc.rust-lang.org
403
+
404
+ You can also use ` rustdoc ` directly to check small fixes. For example,
405
+ ` rustdoc src/doc/reference.md ` will render reference to ` doc/reference.html ` .
406
+ The CSS might be messed up, but you can verify that the HTML is right.
400
407
401
408
Additionally, contributions to the [ rustc-dev-guide] are always welcome. Contributions
402
409
can be made directly at [ the
511
518
* Don't be afraid to ask! The Rust community is friendly and helpful.
512
519
513
520
[ rustc dev guide ] : https://rustc-dev-guide.rust-lang.org/about-this-guide.html
514
- [ gdfrustc ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc /
521
+ [ gdfrustc ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle /
515
522
[ gsearchdocs ] : https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here
516
523
[ rif ] : http://internals.rust-lang.org
517
524
[ rr ] : https://doc.rust-lang.org/book/README.html
0 commit comments