Commit 9c4d05e

authored

Merge pull request #2517 from Kobzol/josh-sync

Update josh sync documentation

2 parents 627dd70 + 776fa0a commit 9c4d05eCopy full SHA for 9c4d05e

File tree

1 file changed

+10

-13

lines changed

src
- external-repos.md

1 file changed

+10

-13

lines changed

`‎src/external-repos.md‎`

Lines changed: 10 additions & 13 deletions

Original file line number	Diff line number	Diff line change
`@@ -40,27 +40,24 @@ implement a new tool feature or test, that should happen in one collective rustc`
`40`	`40`	* `portable-simd` ([sync script](https://github.com/rust-lang/portable-simd/blob/master/subtree-sync.sh))
`41`	`41`	* `rustfmt`
`42`	`42`	* `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`
`49`	`49`
`50`	`50`	`### Josh subtrees`
`51`	`51`
`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).
`53`	`53`
`54`	`54`	`### Synchronizing a Josh subtree`
`55`	`55`
`56`	`56`	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.`
`58`	`59`
`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:`
`64`	`61`	```
`65`	`62`	`cargo install --locked --git https://github.com/rust-lang/josh-sync`
`66`	`63`	```

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 9c4d05e

File tree

1 file changed

1 file changed

`‎src/external-repos.md‎`

0 commit comments