Skip to content
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.

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

Enhance the doc of timing report with graphs #11708

Closed
weihanglo opened this issue Feb 14, 2023 · 3 comments · Fixed by #11798
Closed

Enhance the doc of timing report with graphs #11708

weihanglo opened this issue Feb 14, 2023 · 3 comments · Fixed by #11798
Assignees
Labels
A-documenting-cargo-itself Area: Cargo's documentation A-timings Area: timings C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` E-easy Experience: Easy

Comments

@weihanglo
Copy link
Member

weihanglo commented Feb 14, 2023

Problem

The chapter "Reporting build timings" is well written. It could be way better if we have graphs and tables along with the explanation.

Proposed Solution

The chapter mentions there are two graphs in the report, so at least we could have two graphs and maybe include two tables as well. We could have pointers and indicators on those graphs, making it more learnable and understandable. Human are visual animals anyway.

image

Notes

No response

@weihanglo weihanglo added A-documenting-cargo-itself Area: Cargo's documentation E-easy Experience: Easy C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` A-timings Area: timings labels Feb 14, 2023
@epage
Copy link
Contributor

epage commented Feb 14, 2023

Aside: that graph looks so much better than the old one with toml_edit takinga really long time to compile.

I should see what can be done to improve nom8s compile times.

@heisen-li
Copy link
Contributor

@rustbot claim

@heisen-li
Copy link
Contributor

There are some details that I'd like to discuss, whether to choose Cargo as an example of the image? Because Cargo builds with a large number of units, the picture will be large if it's all displayed. For example, the first time I used it, I had 222 units.

Or adjust the parameters and display them? For example, the following.
image

There is also an issue where the build times on the chart don't match the times on my system, sometimes poor. Should it be adjusted to the system time?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation A-timings Area: timings C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` E-easy Experience: Easy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants