Skip to content

Add git-subtree instructions #2560

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

Closed
wants to merge 4 commits into from
Closed

Add git-subtree instructions #2560

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c7cf451
Extend instructions with download command for git-subtree script
oli-obk Sep 20, 2022
3b781c5
Make instructions a bit clearer on which direction we're talking about
oli-obk Sep 23, 2022
cdc6a04
git subtree is a rustc-repo only operation in either direction
oli-obk Sep 23, 2022
5667a90
git subtree adds branches or commits
oli-obk Sep 23, 2022
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
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,3 +275,57 @@ see <https://rustc-dev-guide.rust-lang.org/building/how-to-build-and-run.html>.

With this, you should now have a working development setup! See
[above](#building-and-testing-miri) for how to proceed working on Miri.

### Syncing the miri subtree

Note: Never rebase a subtree sync (in either direction). Always redo the operation.

All of these operations happen *on a checkout of the rustc repo*. At no time do you
even need a checkout of the miri repo or run any commands in it.

#### Moving changes from the rustc repo to the miri repo

One time setup:

Add your own miri fork as `miri-your-fork` to your rustc checkout:

```
git remote add miri-your-fork [email protected]:your-name/miri.git
```

Every time:

```
ulimit -Ss 1000000
wget https://raw.githubusercontent.com/gitgitgadget/git/fe2e4819b869725f870cd3ce99f1f8150fe17dc1/contrib/subtree/git-subtree.sh
sh git-subtree.sh push --prefix src/tools/miri/ miri-your-fork miri-subtree-sync
rm git-subtree.sh
```

Now you'll have a branch called `miri-subtree-sync` in your miri fork that you can use to open a PR to miri.
Do not rebase this branch. If there are conflicts with the miri repo, you need to use the merge strategy, even if this
is otherwise not permitted for other PRs to the miri repo.

#### Moving changes from the miri repo to the rustc repo

One time setup:

Add the main miri repo as `miri` to your rustc checkout:

```
git remote add miri https://github.com/rust-lang/miri.git
```

Every time:

```
ulimit -Ss 1000000
wget https://raw.githubusercontent.com/gitgitgadget/git/fe2e4819b869725f870cd3ce99f1f8150fe17dc1/contrib/subtree/git-subtree.sh
sh git-subtree.sh pull --prefix src/tools/miri/ miri master
rm git-subtree.sh
```

Now your currently checked out branch has a new merge commit that pulls in the miri changes. Use this to open a PR
against the rustc repo.
Do not rebase this branch. If there are conflicts with the rustc repo, you need to use the merge strategy, even if this
is otherwise not permitted for other PRs to the rustc repo.