5f01316d08
Weekly `cargo update`
Automation to keep dependencies in `Cargo.lock` current.
The following is the output from `cargo update`:
```txt
compiler & tools dependencies:
Locking 27 packages to latest compatible versions
Updating bitflags v2.6.0 -> v2.7.0
Updating clap v4.5.23 -> v4.5.26
Updating clap_builder v4.5.23 -> v4.5.26
Updating clap_complete v4.5.40 -> v4.5.42
Updating clap_derive v4.5.18 -> v4.5.24
Updating handlebars v6.2.0 -> v6.3.0
Updating libz-sys v1.1.20 -> v1.1.21
Updating linux-raw-sys v0.4.14 -> v0.4.15
Updating phf v0.11.2 -> v0.11.3
Updating phf_codegen v0.11.2 -> v0.11.3
Updating phf_generator v0.11.2 -> v0.11.3
Updating phf_shared v0.11.2 -> v0.11.3
Updating pin-project-lite v0.2.15 -> v0.2.16
Updating proc-macro2 v1.0.92 -> v1.0.93
Updating rustix v0.38.42 -> v0.38.43
Updating serde_json v1.0.134 -> v1.0.135
Adding siphasher v1.0.1
Updating syn v2.0.94 -> v2.0.96
Updating thiserror v2.0.9 -> v2.0.11
Updating thiserror-impl v2.0.9 -> v2.0.11
Updating tokio v1.42.0 -> v1.43.0
Updating uuid v1.11.0 -> v1.11.1
Updating wasm-encoder v0.222.0 -> v0.223.0
Adding wasmparser v0.223.0
Updating wast v222.0.0 -> v223.0.0
Updating wat v1.222.0 -> v1.223.0
Updating xattr v1.3.1 -> v1.4.0
note: pass `--verbose` to see 39 unchanged dependencies behind latest
library dependencies:
Locking 0 packages to latest compatible versions
note: pass `--verbose` to see 4 unchanged dependencies behind latest
rustbook dependencies:
Locking 27 packages to latest compatible versions
Updating bitflags v2.6.0 -> v2.7.0
Updating cc v1.2.7 -> v1.2.8
Updating clap v4.5.23 -> v4.5.26
Updating clap_builder v4.5.23 -> v4.5.26
Updating clap_complete v4.5.40 -> v4.5.42
Updating clap_derive v4.5.18 -> v4.5.24
Adding darling v0.20.10
Adding darling_core v0.20.10
Adding darling_macro v0.20.10
Adding derive_builder v0.20.2
Adding derive_builder_core v0.20.2
Adding derive_builder_macro v0.20.2
Updating handlebars v6.2.0 -> v6.3.0
Adding ident_case v1.0.1
Updating linux-raw-sys v0.4.14 -> v0.4.15
Updating phf v0.11.2 -> v0.11.3
Updating phf_codegen v0.11.2 -> v0.11.3
Updating phf_generator v0.11.2 -> v0.11.3
Updating phf_shared v0.11.2 -> v0.11.3
Updating proc-macro2 v1.0.92 -> v1.0.93
Updating rustix v0.38.42 -> v0.38.43
Updating serde_json v1.0.134 -> v1.0.135
Adding siphasher v1.0.1
Updating syn v2.0.94 -> v2.0.96
Updating thiserror v2.0.9 -> v2.0.11
Updating thiserror-impl v2.0.9 -> v2.0.11
Updating winnow v0.6.22 -> v0.6.24
```
|
||
|---|---|---|
| .github/workflows | ||
| ci | ||
| examples | ||
| josh-sync | ||
| src | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| CITATION.cff | ||
| CNAME | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| book.toml | ||
| mermaid-init.js | ||
| mermaid.min.js | ||
| rust-version | ||
| triagebot.toml | ||
README.md
This is a collaborative effort to build a guide that explains how rustc works. The aim of the guide is to help new contributors get oriented to rustc, as well as to help more experienced folks in figuring out some new part of the compiler that they haven't worked on before.
You can read the latest version of the guide here.
You may also find the rustdocs for the compiler itself useful. Note that these are not intended as a guide; it's recommended that you search for the docs you're looking for instead of reading them top to bottom.
For documentation on developing the standard library, see
std-dev-guide.
Contributing to the guide
The guide is useful today, but it has a lot of work still to go.
If you'd like to help improve the guide, we'd love to have you! You can find plenty of issues on the issue tracker. Just post a comment on the issue you would like to work on to make sure that we don't accidentally duplicate work. If you think something is missing, please open an issue about it!
In general, if you don't know how the compiler works, that is not a problem! In that case, what we will do is to schedule a bit of time for you to talk with someone who does know the code, or who wants to pair with you and figure it out. Then you can work on writing up what you learned.
In general, when writing about a particular part of the compiler's code, we recommend that you link to the relevant parts of the rustc rustdocs.
Build Instructions
To build a local static HTML site, install mdbook with:
> cargo install mdbook mdbook-linkcheck2 mdbook-toc mdbook-mermaid
and execute the following command in the root of the repository:
> mdbook build --open
The build files are found in the book/html directory.
Link Validations
We use mdbook-linkcheck2 to validate URLs included in our documentation. Link
checking is not run by default locally, though it is in CI. To enable it
locally, set the environment variable ENABLE_LINKCHECK=1 like in the
following example.
$ ENABLE_LINKCHECK=1 mdbook serve
Table of Contents
We use mdbook-toc to auto-generate TOCs for long sections. You can invoke the preprocessor by
including the <!-- toc --> marker at the place where you want the TOC.
Synchronizing josh subtree with rustc
This repository is linked to rust-lang/rust as a josh subtree. You can use the following commands to synchronize the subtree in both directions.
Pull changes from rust-lang/rust into this repository
- Checkout a new branch that will be used to create a PR into
rust-lang/rustc-dev-guide - Run the pull command
$ cargo run --manifest-path josh-sync/Cargo.toml rustc-pull - Push the branch to your fork and create a PR into
rustc-dev-guide
Push changes from this repository into rust-lang/rust
- Run the push command to create a branch named
<branch-name>in arustcfork under the<gh-username>account$ cargo run --manifest-path josh-sync/Cargo.toml rustc-push <branch-name> <gh-username> - Create a PR from
<branch-name>intorust-lang/rust