summaryrefslogtreecommitdiffstats
path: root/third_party/rust/tracy-rs/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /third_party/rust/tracy-rs/README.md
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/tracy-rs/README.md')
-rw-r--r--third_party/rust/tracy-rs/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/third_party/rust/tracy-rs/README.md b/third_party/rust/tracy-rs/README.md
new file mode 100644
index 0000000000..abdcb51f5f
--- /dev/null
+++ b/third_party/rust/tracy-rs/README.md
@@ -0,0 +1,15 @@
+# tracy-rs
+
+This provides a Rust integration for the Tracy profiling library (https://bitbucket.org/wolfpld/tracy).
+
+## Usage
+
+1) Clone the Tracy library from the above URL.
+2) Follow the steps to build the profiler GUI (e.g. in tracy/profiler/build/unix/).
+3) Follow the steps to build the profiler shared library (e.g. in tracy/library/unix).
+4) Add this crate to your project dependencies, with the 'enable_profiler' cargo feature.
+5) Call `tracy_rs::load` at the start of your application, providing path to library from (3).
+6) Insert the main frame marker `tracy_frame_marker!();` at the end of your frame.
+7) Optionally, add sub-frame markers with `tracy_begin_frame!()` and `tracy_end_frame!()`.
+8) Annotate functions to be profiled with `profile_scope!()`.
+9) Run the application and profiler GUI.