Skip to content

Commit 7928c45

Browse files
committed
Address reviews
1 parent df91b40 commit 7928c45

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -203,16 +203,16 @@ They are just regular files and directories. This is in contrast to `submodule`
203203
There are two synchronization directions: `subtree push` and `subtree pull`.
204204

205205
```
206-
git subtree push -P src/tools/clippy git@github.com:your-github-name/rust-clippy rustup
206+
git subtree push -P src/tools/clippy git@github.com:your-github-name/rust-clippy sync-from-rust
207207
```
208208

209209
takes all the changes that
210210
happened to the copy in this repo and creates commits on the remote repo that match the local
211211
changes. Every local commit that touched the subtree causes a commit on the remote repo, but is
212212
modified to move the files from the specified directory to the tool repo root.
213213

214-
Make sure to not pick the `master` branch, so you can open a normal PR to the tool to merge that
215-
subrepo push.
214+
Make sure to not pick the `master` branch on the tool repo, so you can open a normal PR to the tool
215+
to merge that subrepo push.
216216

217217
```
218218
git subtree pull -P src/tools/clippy https://github.com/rust-lang/rust-clippy master
@@ -224,20 +224,21 @@ the specified directory in the rust repository.
224224

225225
It is recommended that you always do a push first and get that merged to the tool master branch.
226226
Then, when you do a pull, the merge works without conflicts.
227-
While definitely possible to resolve conflicts during a pull, you may have to redo the conflict
227+
While it's definitely possible to resolve conflicts during a pull, you may have to redo the conflict
228228
resolution if your PR doesn't get merged fast enough and there are new conflicts. Do not try to
229229
rebase the result of a `git subtree pull`, rebasing merge commits is a bad idea in general.
230230

231231
You always need to specify the `-P` prefix to the subtree directory and the corresponding remote
232232
repository. If you specify the wrong directory or repository
233233
you'll get very fun merges that try to push the wrong directory to the wrong remote repository.
234-
Luckily you can just abort this without any consequences and try again. It is usually fairly obvious
234+
Luckily you can just abort this without any consequences by throwing away either the pulled commits
235+
in rustc or the pushed branch on the remote and try again. It is usually fairly obvious
235236
that this is happening because you suddenly get thousands of commits that want to be synchronized.
236237

237238
#### Creating a new subtree dependency
238239

239240
If you want to create a new subtree dependency from an existing repository, call (from this
240-
repository's root directory!!)
241+
repository's root directory!)
241242

242243
```
243244
git subtree add -P src/tools/clippy https://github.com/rust-lang/rust-clippy.git master
@@ -247,7 +248,7 @@ This will create a new commit, which you may not rebase under any circumstances!
247248
and redo the operation if you need to rebase.
248249

249250
Now you're done, the `src/tools/clippy` directory behaves as if clippy were part of the rustc
250-
monorepo, so no one but you (or others that synchronize subtrees) needs actually use `git subtree`.
251+
monorepo, so no one but you (or others that synchronize subtrees) actually needs to use `git subtree`.
251252

252253

253254
### External Dependencies (submodules)

0 commit comments

Comments
 (0)