[Merged by Bors] - Cargo --timings option has been stabilized. Update profiling.md.
#4850
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
james7132
approved these changes
May 26, 2022
jakobhellermann
suggested changes
May 26, 2022
docs/profiling.md
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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.
alice-i-cecile
added
C-Docs
|
Once the comment above is addressed I'm happy to merge this. |
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
May 30, 2022
…4850) As of rust-lang/cargo#10245 `--timings` has been stabilized. Update profiling.md to reflect this. Co-authored-by: devil-ira <[email protected]>
|
Build failed (retrying...): |
bors bot
pushed a commit
that referenced
this pull request
May 30, 2022
…4850) As of rust-lang/cargo#10245 `--timings` has been stabilized. Update profiling.md to reflect this. Co-authored-by: devil-ira <[email protected]>
|
Build failed: |
Co-authored-by: Alice Cecile <[email protected]>
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
May 30, 2022
…4850) As of rust-lang/cargo#10245 `--timings` has been stabilized. Update profiling.md to reflect this. Co-authored-by: devil-ira <[email protected]>
bors
bot
changed the title
--timings option has been stabilized. Update profiling.md.--timings option has been stabilized. Update profiling.md.
james7132
pushed a commit
to james7132/bevy
that referenced
this pull request
Jun 7, 2022
…evyengine#4850) As of rust-lang/cargo#10245 `--timings` has been stabilized. Update profiling.md to reflect this. Co-authored-by: devil-ira <[email protected]>
ItsDoot
pushed a commit
to ItsDoot/bevy
that referenced
this pull request
Feb 1, 2023
…evyengine#4850) As of rust-lang/cargo#10245 `--timings` has been stabilized. Update profiling.md to reflect this. Co-authored-by: devil-ira <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of rust-lang/cargo#10245
--timingshas been stabilized.Update profiling.md to reflect this.