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.

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

[Merged by Bors] - Cargo --timings option has been stabilized. Update profiling.md. #4850

Closed
wants to merge 4 commits into from
Closed

[Merged by Bors] - Cargo --timings option has been stabilized. Update profiling.md. #4850

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
482622c
Update profiling.md
tim-blackbird May 26, 2022
740de51
Remove unnecessary backticks
tim-blackbird May 26, 2022
58533d8
Add more info
tim-blackbird May 30, 2022
9d363f7
Update docs/profiling.md
tim-blackbird May 30, 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
2 changes: 1 addition & 1 deletion docs/profiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ After closing your app, an interactive `svg` file will be produced:

## Project Compile Times

This requires nightly rust (`rustup default nightly`). Append ```-Ztimings``` to your app's cargo command (ex: `cargo build -Ztimings`). If you want a "full" profile, make sure you run `cargo clean` first. Open the produced `cargo-timing.html` file in your browser of choice. This will show how much time each crate in your app's dependency tree took to build.
Append ```--timings``` to your app's cargo command (ex: `cargo build --timings`). If you want a "full" profile, make sure you run `cargo clean` first. Open the produced `cargo-timing.html` file in your browser of choice. This will show how much time each crate in your app's dependency tree took to build.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the stabilized --timings option cargo doesn't save a cargo-timing.html in the currect directory anymore, but instead writes it to the target directory and logs its location:

Timing report saved to /home/user/.cache/rust/cargo-timings/cargo-timing-20220526T190433Z.html

We should tweak the text to make that more clear.


![image](https://user-images.githubusercontent.com/2694663/141657811-f4e15e3b-c9fc-491b-9313-236fd8c01288.png)