Document josh subtrees and update subtree repository list #2182
Conversation
src/external-repos.md
Outdated
| @@ -29,6 +28,20 @@ to these tools should be filed against the tools directly in their respective | |||
| upstream repositories. The exception is that when rustc changes are required to | |||
| implement a new tool feature or test, that should happen in one collective rustc PR. | |||
|
|
|||
| `subtree` dependencies are currently managed by two distinct approaches: | |||
|
|
|||
| * Using `git subtree` directly | |||
There was a problem hiding this comment.
| * Using `git subtree` directly | |
| * Using `git subtree` |
There's no "indirect" usage so I find the additional qualifier confusing
There was a problem hiding this comment.
I wanted to distinguish "using subtrees via josh" and "using subtrees via git subtree", but the word was extraneous, I suppose. Removed it.
src/external-repos.md
Outdated
| 3. As a git submodule (e.g. `cargo`) | ||
|
|
||
| As a general rule, use crates.io for libraries that could be useful for others in the ecosystem; use | ||
| subtrees for tools that depend on compiler internals and need to be updated if there are breaking | ||
| changes; and use submodules for tools that are independent of the compiler. | ||
|
|
||
| ## External Dependencies (subtree) | ||
| ## External Dependencies (subtrees) | ||
|
|
||
| As a developer to this repository, you don't have to treat the following external projects | ||
| differently from other crates that are directly in this repo: |
There was a problem hiding this comment.
That's not quite true, tools generally prefer PRs to their own repos when changes don't have to be done in lockstep with Rust compiler changes.
There was a problem hiding this comment.
This was pre-existing, but I agree it was confusing, I reworded it.
jieyouxu
added
S-waiting-on-review
| @@ -29,6 +27,20 @@ to these tools should be filed against the tools directly in their respective | |||
| upstream repositories. The exception is that when rustc changes are required to | |||
| implement a new tool feature or test, that should happen in one collective rustc PR. | |||
|
|
|||
| `subtree` dependencies are currently managed by two distinct approaches: | |||
|
|
|||
| * Using `git subtree` | |||
There was a problem hiding this comment.
portable-simd also uses this; it seems to be entirely missing from this list?
There was a problem hiding this comment.
The list was incomplete before, I added a few entries, but since there was no global list before that, I didn't notice portable-simd. Good catch! Added it in #2214.
Mention our usage of josh in
miriandrust-analyzer, and add the cranelift backend to the list.