Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Link to forge instead of duplicating toolstate info #1664

Merged
merged 3 commits into from
Apr 9, 2023
Merged

Link to forge instead of duplicating toolstate info #1664

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ee0f3e
fix incorrect miri mentions in "External Repos" chapter
jyn514 Apr 6, 2023
a3b2cc8
Remove detailed toolstate section
jyn514 Apr 8, 2023
72e06b0
document that it's rare for books to break
jyn514 Apr 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/external-repos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ differently from other crates that are directly in this repo:
* [rustfmt](https://github.com/rust-lang/rustfmt)
* [rust-analyzer](https://github.com/rust-lang/rust-analyzer)

[Miri]: https://github.com/rust-lang/miri
[Cargo]: https://github.com/rust-lang/cargo

In contrast to `submodule` dependencies
(see below for those), the `subtree` dependencies are just regular files and directories which can
be updated in tree. However, if possible, enhancements, bug fixes, etc. specific
Expand Down Expand Up @@ -88,7 +91,7 @@ subtrees) actually needs to use `git subtree`.
Building Rust will also use external git repositories tracked using [git
submodules]. The complete list may be found in the [`.gitmodules`] file. Some
of these projects are required (like `stdarch` for the standard library) and
some of them are optional (like [Miri]).
some of them are optional (like `src/doc/book`).

Usage of submodules is discussed more in the [Using Git
chapter](git.md#git-submodules).
Expand All @@ -114,7 +117,7 @@ the week leading up to the beta cut.

Rust's build system builds a number of tools that make use of the internals of
the compiler and that are hosted in a separate repository, and included in Rust
via git submodules (such as [Miri]). If these tools break because of your
via git submodules (such as [Cargo]). If these tools break because of your
jyn514 marked this conversation as resolved.
Show resolved Hide resolved
changes, you may run into a sort of "chicken and egg" problem. These tools rely
on the latest compiler to be built so you can't update them (in their own
repositories) to reflect your changes to the compiler until those changes are
Expand Down