Skip to content

Commit 1ecb68d

Browse files
authored
Merge pull request #2517 from Kobzol/josh-sync
Update josh sync documentation
2 parents 44bec00 + 6c96e7a commit 1ecb68d

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

src/doc/rustc-dev-guide/src/external-repos.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,27 +40,24 @@ implement a new tool feature or test, that should happen in one collective rustc
4040
* `portable-simd` ([sync script](https://github.com/rust-lang/portable-simd/blob/master/subtree-sync.sh))
4141
* `rustfmt`
4242
* `rustc_codegen_cranelift` ([sync script](https://github.com/rust-lang/rustc_codegen_cranelift/blob/113af154d459e41b3dc2c5d7d878e3d3a8f33c69/scripts/rustup.sh#L7))
43-
* Using the [josh] tool
44-
* `miri` ([sync guide](https://github.com/rust-lang/miri/blob/master/CONTRIBUTING.md#advanced-topic-syncing-with-the-rustc-repo))
45-
* `rust-analyzer` ([sync script](https://github.com/rust-lang/rust-analyzer/blob/2e13684be123eca7181aa48e043e185d8044a84a/xtask/src/release.rs#L147))
46-
* `rustc-dev-guide` ([josh sync](#synchronizing-a-josh-subtree))
47-
* `compiler-builtins` ([josh sync](#synchronizing-a-josh-subtree))
48-
* `stdarch` ([josh sync](#synchronizing-a-josh-subtree))
43+
* Using the [josh](#synchronizing-a-josh-subtree) tool
44+
* `miri`
45+
* `rust-analyzer`
46+
* `rustc-dev-guide`
47+
* `compiler-builtins`
48+
* `stdarch`
4949

5050
### Josh subtrees
5151

52-
The [josh] tool is an alternative to git subtrees, which manages git history in a different way and scales better to larger repositories. Specific tooling is required to work with josh; you can check out the `miri` or `rust-analyzer` scripts linked above for inspiration. We provide a helper [`rustc-josh-sync`][josh-sync] tool to help with the synchronization, described [below](#synchronizing-a-josh-subtree).
52+
The [josh] tool is an alternative to git subtrees, which manages git history in a different way and scales better to larger repositories. Specific tooling is required to work with josh. We provide a helper [`rustc-josh-sync`][josh-sync] tool to help with the synchronization, described [below](#synchronizing-a-josh-subtree).
5353

5454
### Synchronizing a Josh subtree
5555

5656
We use a dedicated tool called [`rustc-josh-sync`][josh-sync] for performing Josh subtree updates.
57-
Currently, we are migrating Josh repositories to it. So far, it is used in:
57+
The commands below can be used for all our Josh subtrees, although note that `miri`
58+
requires you to perform some [additional steps](https://github.com/rust-lang/miri/blob/master/CONTRIBUTING.md#advanced-topic-syncing-with-the-rustc-repo) during pulls.
5859

59-
- compiler-builtins
60-
- rustc-dev-guide
61-
- stdarch
62-
63-
To install the tool:
60+
You can install the tool using the following command:
6461
```
6562
cargo install --locked --git https://github.com/rust-lang/josh-sync
6663
```

0 commit comments

Comments
 (0)