Improve Tracy profiling docs (quickstart, split into sections) #21565
+27
−10
Conversation
This file contains hidden or 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
alice-i-cecile
approved these changes
Oct 16, 2025
alice-i-cecile
added
C-Docs
ChristopherBiscardi
approved these changes
Oct 16, 2025
Contributor
ChristopherBiscardi
left a comment
ChristopherBiscardi
left a comment
There was a problem hiding this comment.
love these changes. Should make it much easier for people to get into profiling their applications.
mockersf
approved these changes
Oct 16, 2025
alice-i-cecile
added
S-Ready-For-Final-Review
mate-h
pushed a commit
to mate-h/bevy
that referenced
this pull request
Oct 22, 2025
…ngine#21565) # Objective The Tracy profiling docs were confusing and overwhelming to some for a number of reasons: - only mentioning that you can capture through the UI in a single sentence quite a bit down - interspersed installation, version-matching and usage instructions - lack of clear steps - lack of separation between topics ## Solution I've added a Quickstart which guides people through using the Tracy UI to capture, including some more installation instructions for various platforms (unofficial macos/linux binary builds, link to repology packages list). Additionally, I've created the following sub-titles (sub-headers?) - `Finding the correct tracy version` - `Commandline capture (less overhead)`, which is where most of the previous instructions ended up - `Using the Tracy UI`, for the basic usage guide with screenshots Rendered version: https://github.com/laundmo/bevy/blob/improve-tracy-profiling-docs/docs/profiling.md#tracy-profiler
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 22, 2025
# Objective In - #21565 i added a note to the profiling docs that the correct tracy version for bevy 0.17 is tracy 0.12.2 But in a recent patch release, the version of the tracy libraries was bumped and now requires tracy 0.13. While this is a breaking change i dont think should happen on path releases, it shows that my mentioning of the version was way too optimistic, and its [already caused some frustration](https://discord.com/channels/691052431525675048/691052431974465548/1440429953232535623) ## Solution - remove the mention of any specific version from the docs Co-authored-by: François Mockers <[email protected]>
beicause
pushed a commit
to beicause/bevy
that referenced
this pull request
Nov 26, 2025
# Objective In - bevyengine#21565 i added a note to the profiling docs that the correct tracy version for bevy 0.17 is tracy 0.12.2 But in a recent patch release, the version of the tracy libraries was bumped and now requires tracy 0.13. While this is a breaking change i dont think should happen on path releases, it shows that my mentioning of the version was way too optimistic, and its [already caused some frustration](https://discord.com/channels/691052431525675048/691052431974465548/1440429953232535623) ## Solution - remove the mention of any specific version from the docs Co-authored-by: François Mockers <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Objective
The Tracy profiling docs were confusing and overwhelming to some for a number of reasons:
Solution
I've added a Quickstart which guides people through using the Tracy UI to capture, including some more installation instructions for various platforms (unofficial macos/linux binary builds, link to repology packages list).
Additionally, I've created the following sub-titles (sub-headers?)
Finding the correct tracy versionCommandline capture (less overhead), which is where most of the previous instructions ended upUsing the Tracy UI, for the basic usage guide with screenshotsRendered version: https://github.com/laundmo/bevy/blob/improve-tracy-profiling-docs/docs/profiling.md#tracy-profiler