You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: triage/README.md
+20-22Lines changed: 20 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,7 @@ usage.
8
8
- Mark-Simulacrum
9
9
- rylev
10
10
- pnkfelix
11
+
- kobzol
11
12
12
13
Monday evening to Tuesday afternoon in North America is a good time to do it
13
14
because This Week in Rust (see below) is usually published on Wednesday, US time,
@@ -48,6 +49,7 @@ are actually not regressions and have only been labeled as such due to noise.
48
49
Look for significant changes (regressions or improvements) in the following:
49
50
- instruction count
50
51
- max rss
52
+
- binary size
51
53
52
54
When working with graphs:
53
55
- Click and drag a region of a graph to zoom in on it. This is useful when data
@@ -59,12 +61,11 @@ To view the code changes:
59
61
open the page of commits in the merge.
60
62
61
63
Understanding the comparison page:
62
-
- Each benchmark is listed with the min, max and the avg percentage change
64
+
- Each benchmark is listed with the percentage change
63
65
(red indicates regressions, green indicates improvements) across the various
64
66
benchmarks run (e.g., full, incremental-full, incremental-unchanged, etc.).
65
-
- Clicking on a specific benchmark will show the results for each of the various
66
-
benchmarks. Clicking on the percentages will open a more specific detail view
67
-
of timing for queries run during compilation.
67
+
- Clicking on a specific benchmark run will show a detailed view of the results, including
68
+
history chart and links to self-profile query timings.
68
69
69
70
### Interpreting results
70
71
@@ -78,37 +79,34 @@ For help understanding how to interpret results, consult the [comparison analysi
78
79
### Ping PR Author/Reviewer
79
80
80
81
Single PR in Merge:
81
-
- Add a comment to the PR pointing to the "compare" page (unless someone else
82
-
has already done that).
83
82
- In the case of a regression, ask the author for a response. If it's a big
84
83
regression, consider requesting the author revert their changes. It may
85
-
be worth looking through the comments to see if any perf CI runs were done,
86
-
and whether the regression was expected.
84
+
be worth looking through the comments to see if the regression was expected.
87
85
88
86
Difficult cases: the merge was a rollup of multiple PRs.
89
-
- Look through the PRs and try to determine which was the cause. Often you
90
-
can easily tell that one or more PRs could not have caused the change, e.g.
91
-
because they made trivial changes, documentation-only changes, etc.
92
-
- If there are still PRs left over, look at the 'detailed-query' page on perf.rlo: often, there is a single timing pass that improved significantly, and the name may give you a hint. You can find the page by expanding the dropdown for the build with the greatest change, then clicking on the percent change.
93
-
-If you can't narrow it down to a single PR, in the rollup PR ask all the
94
-
authors who might be responsible.
95
-
- Once you have narrowed it down to a single PR, treat it like an easy case,
96
-
above.
87
+
- Look through the PRs and try to determine which was the cause. You can start
88
+
a perf. run for a single PR merged in the rollup using the "unrolled build"
89
+
table (see e.g. [here](https://github.com/rust-lang/rust/pull/119313#issuecomment-1869441617)) with
90
+
the `@rust-timer build $SHA` command.
91
+
-Often you can easily tell that one or more PRs could not have caused the change, e.g.
92
+
because they made trivial changes, documentation-only changes, etc., so start with the
93
+
perf. runs for the most "suspicious" PRs.
94
+
- Once you have narrowed it down to a single PR, treat it like a single PR case, see above.
97
95
- You might want to remind the author to use "@bors rollup=never" for PRs
98
96
that are likely to affect performance.
99
-
- Add an entry to the triage log, as for the easy cases.
97
+
- Add an entry to the triage log, as for the single PR cases.
100
98
101
99
### Add analysis and follow-ups to report
102
100
103
-
- For each entry in the report, include useful details, such as the size of the regression/improvement, and any promises of follow-up action
104
-
from authors in the case of a regression.
101
+
- For each entry in the report, include useful details, such as the size of the regression/improvement,
102
+
and any promises of follow-up action from authors in the case of a regression.
105
103
106
104
### This Week in Rust
107
105
108
106
Once finished, file a PR adding a link to the log entry in [This Week in
0 commit comments