diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ca5a289..8dcdbb1d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -95,12 +95,14 @@ cargo run --release --features profile-with-tracy -- serve 3. In Tracy, connect to the running `rojo` process. 4. Perform the actions you want to profile (syncing, building, etc.) and inspect the timeline in Tracy. -Short-lived commands like `build` may exit before Tracy can connect. Set `TRACY_NO_EXIT=1` to keep the process alive until you connect: +Short-lived commands like `build` may exit before Tracy can connect. Set `TRACY_NO_EXIT=1` to keep the process alive until you connect (not supported on macOS): ```bash -TRACY_NO_EXIT=1 cargo run --release --features profile-with-tracy -- build +TRACY_NO_EXIT=1 cargo run --release --features profile-with-tracy -- build test-projects/benchmark_small_place --output /tmp/out.rbxlx ``` +On macOS, prefer profiling long-running commands like `serve` instead. + ### Adding instrumentation Use these `profiling` macros in Rust code: diff --git a/Cargo.toml b/Cargo.toml index edf211a1..b950b917 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -31,7 +31,8 @@ default = [] dev_live_assets = [] # Run Rojo with this feature to open a Tracy session. -# Currently uses protocol v63, last supported in Tracy 0.9.1. +# See CONTRIBUTING.md for setup instructions. Match the Tracy GUI version to +# the tracy-client-sys version in Cargo.lock (see the tracy-client version table). profile-with-tracy = ["profiling/profile-with-tracy"] [workspace]