Skip to content

Commit 02bad6b

Browse files
committed
Remove josh-sync tooling and update README
1 parent d5ad5d7 commit 02bad6b

File tree

6 files changed

+5
-789
lines changed

6 files changed

+5
-789
lines changed

README.md

Lines changed: 5 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -72,49 +72,24 @@ including the `<!-- toc -->` marker at the place where you want the TOC.
7272

7373
## Synchronizing josh subtree with rustc
7474

75-
This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the following commands to synchronize the subtree in both directions.
75+
This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization.
7676

77-
You'll need to install `josh-proxy` locally via
78-
79-
```
80-
cargo install josh-proxy --git https://github.com/josh-project/josh --tag r24.10.04
81-
```
82-
Older versions of `josh-proxy` may not round trip commits losslessly so it is important to install this exact version.
77+
You can install the tool using `cargo install --locked --git https://github.com/rust-lang/josh-sync`.
8378

8479
### Pull changes from `rust-lang/rust` into this repository
8580

8681
1) Checkout a new branch that will be used to create a PR into `rust-lang/rustc-dev-guide`
8782
2) Run the pull command
8883
```
89-
cargo run --manifest-path josh-sync/Cargo.toml rustc-pull
84+
rustc-josh-sync pull
9085
```
9186
3) Push the branch to your fork and create a PR into `rustc-dev-guide`
87+
- If you have `gh` CLI installed, `rustc-josh-sync` can create the PR for you.
9288
9389
### Push changes from this repository into `rust-lang/rust`
9490
95-
NOTE: If you use Git protocol to push to your fork of `rust-lang/rust`,
96-
ensure that you have this entry in your Git config,
97-
else the 2 steps that follow would prompt for a username and password:
98-
99-
```
100-
[url "git@github.com:"]
101-
insteadOf = "https://github.com/"
102-
```
103-
10491
1) Run the push command to create a branch named `<branch-name>` in a `rustc` fork under the `<gh-username>` account
10592
```
106-
cargo run --manifest-path josh-sync/Cargo.toml rustc-push <branch-name> <gh-username>
93+
rustc-josh-sync push <branch-name> <gh-username>
10794
```
10895
2) Create a PR from `<branch-name>` into `rust-lang/rust`
109-
110-
#### Minimal git config
111-
112-
For simplicity (ease of implementation purposes), the josh-sync script simply calls out to system git. This means that the git invocation may be influenced by global (or local) git configuration.
113-
114-
You may observe "Nothing to pull" even if you *know* rustc-pull has something to pull if your global git config sets `fetch.prunetags = true` (and possibly other configurations may cause unexpected outcomes).
115-
116-
To minimize the likelihood of this happening, you may wish to keep a separate *minimal* git config that *only* has `[user]` entries from global git config, then repoint system git to use the minimal git config instead. E.g.
117-
118-
```
119-
GIT_CONFIG_GLOBAL=/path/to/minimal/gitconfig GIT_CONFIG_SYSTEM='' cargo run --manifest-path josh-sync/Cargo.toml -- rustc-pull
120-
```

0 commit comments

Comments
 (0)