Skip to content

Commit 9858a4e

Browse files
committed
fixup! Update backport, release and sync documentation
1 parent a53579c commit 9858a4e

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

book/src/development/infrastructure/backport.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,20 @@ some explanation and are quite subjective. Good judgement is required.
1919
1. **Is the fix worth a backport?**
2020

2121
This is really subjective. An ICE fix usually is. Moving a lint to a _lower_
22-
group usually as well. An FP fix usually not (on its own). If a backport is
23-
done anyway, FP fixes might also be included. If the PR has a lot of changes,
24-
backports must be considered more carefully.
22+
group (from warn- to allow-by-default) usually as well. An FP fix usually not
23+
(on its own). If a backport is done anyway, FP fixes might also be included.
24+
If the PR has a lot of changes, backports must be considered more carefully.
2525

2626
2. **Is the problem that was fixed by the PR already in `beta`?**
2727

2828
It could be that the problem that was fixed by the PR hasn't made it to the
2929
`beta` branch of the Rust repo yet. If that's the case, and the fix is
30-
already synced to the Rust repo, the fix doesn't need to be backported. If
31-
the fix PR is not synced yet, the fix PR either needs to be "backported" to
32-
the Rust `master` branch or to `beta` in the next backport cycle.
30+
already synced to the Rust repo, the fix doesn't need to be backported, as it
31+
will hit stable together with the commit that introduced the problem. If the
32+
fix PR is not synced yet, the fix PR either needs to be "backported" to the
33+
Rust `master` branch or to `beta` in the next backport cycle.
3334

34-
3. **Is the fix already synced to `master`?**
35+
3. **Make sure that the fix is on `master` before porting to `beta`**
3536

3637
The fix must already be synced to the Rust `master` branch. Otherwise, the
3738
next `beta` will be missing this fix again. If it is not yet in `master` it
@@ -67,9 +68,9 @@ git reset --hard upstream/beta
6768

6869
## Backport the changes
6970

70-
When PR is merged with the GitHub merge queue, the PR is closed with the message
71+
When a PR is merged with the GitHub merge queue, the PR is closed with the message
7172

72-
> <PR title> (#<PR number>)
73+
> \<PR title\> (#\<PR number\>)
7374
7475
This commit needs to be backported. To do that, find the `<sha1>` of that commit
7576
and run the following command in the clone of the **Rust repository**:
@@ -95,7 +96,7 @@ Backports:
9596
- <Link to the Clippy PR>
9697
- ...
9798
98-
<Short summary what is backported and why>
99+
<Short summary of what is backported and why>
99100
```
100101

101102
Mark is from the release team and they ultimately have to merge the PR before

book/src/development/infrastructure/release.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ git commit -m "Bump Clippy version -> 0.1.XY" **/*Cargo.toml
4848

4949
## Find the Clippy commit
5050

51-
For both, updating the `beta` and the `stable` branch, the first step is to find
51+
For both updating the `beta` and the `stable` branch, the first step is to find
5252
the Clippy commit of the last Clippy sync done in the respective Rust branch.
5353

5454
Running the following commands _in the Rust repo_ will get the commit for the
@@ -88,7 +88,7 @@ git push upstream stable
8888
After updating the `stable` branch, tag the HEAD commit and push it to the
8989
Clippy repo.
9090

91-
> Note: Only push the tag, once the Deploy GitHub action of the `beta` branch is
91+
> Note: Only push the tag once the Deploy GitHub action of the `beta` branch is
9292
> finished. Otherwise the deploy for the tag might fail.
9393
9494
```bash

0 commit comments

Comments
 (0)