user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src
History
bors cefe1dcef0 Auto merge of #127786 - ehuss:rustbook-workspace, r=Mark-Simulacrum 
Move rustbook to its own workspace.

This moves rustbook (the wrapper around mdbook) to its own Cargo workspace. This is done for two reasons:

- Some users want to avoid having to check out documentation submodules if they are not working on documentation. These submodules are required for submodules that have Cargo dependencies in the tree (such as mdbook preprocessors).
- The [pinned `memchr`](eb72697e41/compiler/rustc_ast/Cargo.toml (L10)) is causing problems with updating. That pin is only necessary for the standard library, but unfortunately it is affecting all other crates.

This will have some drawbacks:

- A slight increase in the vendor directory size. My measurement shows about a 14M increase (0.7%), but somehow the compressed filesize is smaller.
- The dependencies for rustbook now need to be managed separately. I have updated the cron job to try to mitigate this.
- There will be a slight dist build time penalty. I'm not sure what it will be, since it heavily depends on the machine, but I suspect in the 30-45s range.
- Adds more complexity to things like bootstrap and tidy.

There are a few other alternatives considered:

- Publish preprocessors on crates.io. This adds the burden of publishing every change, and ensuring those publishes happen and the sources don't get out of sync, and somehow syncing those updates back to rust-lang/rust during the automatic updates. This is also more work.
- Move the submodules to subtrees. These have the added burden of doing updates in a way that is more difficult than submodules. I believe it also causes problems with GitHub's `#NNNN` tagging and closing issues. This is also more work.

The only thing I haven't tested here is the cron job. However, there's a pretty decent chance this won't pass CI, or that I missed something.
2024-07-22 20:12:52 +00:00
..
bootstrap Move rustbook to its own workspace. 2024-07-22 07:20:57 -07:00
ci Rollup merge of #127923 - ferrocene:use-reuse-tool-4.0, r=pietroalbini 2024-07-22 11:40:21 -05:00
doc Rollup merge of #117932 - GuillaumeGomez:update-rustdoc-book, r=notriddle 2024-07-22 11:40:18 -05:00
etc Rewrite test-float-parse in Rust 2024-07-20 11:39:34 -05:00
librustdoc rustdoc: revert spacing change in item-table 2024-07-21 23:21:49 -07:00
llvm-project@c54cff0e6e Update LLVM submodule 2024-07-05 22:06:57 +08:00
rustdoc-json-types Add rustdoc-json support for use<> 2024-07-12 05:24:51 -04:00
tools Auto merge of #127786 - ehuss:rustbook-workspace, r=Mark-Simulacrum 2024-07-22 20:12:52 +00:00
README.md
stage0 bump stage0 compiler 2024-06-11 15:10:03 +02:00
version Bump to 1.82 2024-07-20 10:30:39 -04:00

README.md

This directory contains some source code for the Rust project, including:

  • The bootstrapping build system
  • Various submodules for tools, like cargo, tidy, etc.

For more information on how various parts of the compiler work, see the rustc dev guide.