it can be found [here][rctd].
### External Dependencies
-[external-dependencies]: #external-dependencies
Currently building Rust will also build the following external projects:
before the PR is merged.
#### Breaking Tools Built With The Compiler
-[breaking-tools-built-with-the-compiler]: #breaking-tools-built-with-the-compiler
Rust's build system builds a number of tools that make use of the
internals of the compiler. This includes
`config.toml.example` in the root directory of the Rust repository.
Set `submodules = false` in the `[build]` section. This will prevent `x.py`
from resetting to the original branch after you make your changes. If you
- need to [update any submodules to their latest versions][updating-submodules],
+ need to [update any submodules to their latest versions](#updating-submodules),
see the section of this file about that for more information.
2. (optional) Run `./x.py test src/tools/rustfmt` (substituting the submodule
that broke for `rustfmt`). Fix any errors in the submodule (and possibly others).
8. (optional) Send a PR to rust-lang/rust updating the submodule.
#### Updating submodules
-[updating-submodules]: #updating-submodules
These instructions are specific to updating `rustfmt`, however they may apply
to the other submodules as well. Please help by improving these instructions
the submodule to. Running `./x.py build` should work now.
## Writing Documentation
-[writing-documentation]: #writing-documentation
Documentation improvements are very welcome. The source of `doc.rust-lang.org`
is located in `src/doc` in the tree, and standard API documentation is generated
are issues for beginners and advanced compiler devs alike!
## Issue Triage
-[issue-triage]: #issue-triage
Sometimes, an issue will stay open, even though the bug has been fixed. And
sometimes, the original bug may go stale because something has changed in the
[rfcbot]: https://github.com/anp/rfcbot-rs/
## Out-of-tree Contributions
-[out-of-tree-contributions]: #out-of-tree-contributions
There are a number of other ways to contribute to Rust that don't deal with
this repository.
[community-library]: https://github.com/rust-lang/rfcs/labels/A-community-library
## Helpful Links and Information
-[helpful-info]: #helpful-info
For people new to Rust, and just starting to contribute, or even for
more seasoned developers, some useful places to look for information