From 6e782725f6905ee2dd76e521971d822f7ff32271 Mon Sep 17 00:00:00 2001 From: AmeKnite <104745335+ameknite@users.noreply.github.com> Date: Wed, 24 Jan 2024 21:12:04 -0600 Subject: [PATCH 1/4] fix link to tracy --- docs/profiling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/profiling.md b/docs/profiling.md index 7f0dc155cbfbc..917beae356e19 100644 --- a/docs/profiling.md +++ b/docs/profiling.md @@ -40,7 +40,7 @@ The [Tracy profiling tool](https://github.com/wolfpld/tracy) is: There are binaries available for Windows, and installation / build instructions for other operating systems can be found in the [Tracy documentation PDF](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf). -It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/latest/crates/bevy_log/Cargo.toml#L25). +It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/main/crates/bevy_log/Cargo.toml#L30). In one terminal, run: `./capture-release -o my_capture.tracy` From 491e1461ce7af3c9e26442bb7d7852dfe4aceb2c Mon Sep 17 00:00:00 2001 From: AmeKnite <104745335+ameknite@users.noreply.github.com> Date: Thu, 25 Jan 2024 12:27:39 -0600 Subject: [PATCH 2/4] keep link in the latest branch --- docs/profiling.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/profiling.md b/docs/profiling.md index 917beae356e19..35a270d08f971 100644 --- a/docs/profiling.md +++ b/docs/profiling.md @@ -2,12 +2,14 @@ ## Table of Contents -- [Runtime](#runtime) - - [Chrome tracing format](#chrome-tracing-format) - - [Tracy profiler](#tracy-profiler) - - [Adding your own spans](#adding-your-own-spans) - - [Perf flame graph](#perf-flame-graph) -- [Compile time](#compile-time) +- [Profiling](#profiling) + - [Table of Contents](#table-of-contents) + - [Runtime](#runtime) + - [Chrome tracing format](#chrome-tracing-format) + - [Tracy profiler](#tracy-profiler) + - [Adding your own spans](#adding-your-own-spans) + - [`perf` Flame Graph](#perf-flame-graph) + - [Compile time](#compile-time) ## Runtime @@ -40,7 +42,7 @@ The [Tracy profiling tool](https://github.com/wolfpld/tracy) is: There are binaries available for Windows, and installation / build instructions for other operating systems can be found in the [Tracy documentation PDF](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf). -It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/main/crates/bevy_log/Cargo.toml#L30). +It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/latest/crates/bevy_log/Cargo.toml#L30). In one terminal, run: `./capture-release -o my_capture.tracy` From 61a6b30acf6beeeeca48625fb79bd0920c0ba2c3 Mon Sep 17 00:00:00 2001 From: AmeKnite <104745335+ameknite@users.noreply.github.com> Date: Thu, 25 Jan 2024 12:32:18 -0600 Subject: [PATCH 3/4] revert table of contents --- docs/profiling.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/profiling.md b/docs/profiling.md index 35a270d08f971..f189c51162542 100644 --- a/docs/profiling.md +++ b/docs/profiling.md @@ -2,14 +2,12 @@ ## Table of Contents -- [Profiling](#profiling) - - [Table of Contents](#table-of-contents) - - [Runtime](#runtime) - - [Chrome tracing format](#chrome-tracing-format) - - [Tracy profiler](#tracy-profiler) - - [Adding your own spans](#adding-your-own-spans) - - [`perf` Flame Graph](#perf-flame-graph) - - [Compile time](#compile-time) +- [Runtime](#runtime) + - [Chrome tracing format](#chrome-tracing-format) + - [Tracy profiler](#tracy-profiler) + - [Adding your own spans](#adding-your-own-spans) + - [Perf flame graph](#perf-flame-graph) +- [Compile time](#compile-time) ## Runtime From 82ecc3dda4bdb053a858b09bfee5125e5028806a Mon Sep 17 00:00:00 2001 From: Ame <104745335+ameknite@users.noreply.github.com> Date: Sat, 27 Jan 2024 12:50:41 -0600 Subject: [PATCH 4/4] Update docs/profiling.md Co-authored-by: Alice Cecile --- docs/profiling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/profiling.md b/docs/profiling.md index f189c51162542..45945024a5a38 100644 --- a/docs/profiling.md +++ b/docs/profiling.md @@ -40,7 +40,7 @@ The [Tracy profiling tool](https://github.com/wolfpld/tracy) is: There are binaries available for Windows, and installation / build instructions for other operating systems can be found in the [Tracy documentation PDF](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf). -It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/latest/crates/bevy_log/Cargo.toml#L30). +It has a command line capture tool that can record the execution of graphical applications, saving it as a profile file. Tracy has a GUI to inspect these profile files. The GUI app also supports live capture, showing you in real time the trace of your app. The version of tracy must be matched to the version of tracing-tracy used in bevy. A compatibility table can be found on [crates.io](https://crates.io/crates/tracing-tracy) and the version used can be found [here](https://github.com/bevyengine/bevy/blob/latest/crates/bevy_log/Cargo.toml). In one terminal, run: `./capture-release -o my_capture.tracy`