x11-misc/neovide.neovide
1
0
Fork 0
mirror of https://github.com/neovide/neovide.git synced 2026-09-10 07:16:25 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: update tracy dependency instructions (#3472)

Browse source
This commit is contained in:
Alexsander Falcucci 2026-04-13 22:50:52 +02:00 committed by GitHub
parent 473504a49e
commit afb366be0c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 26 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Cargo.lock generated
View file

@ -3341,9 +3341,9 @@ dependencies = [
[[package]]
name = "tracy-client-sys"
version = "0.27.0"
version = "0.28.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2fb391ac70462b3097a755618fbf9c8f95ecc1eb379a414f7b46f202ed10db1f"
checksum = "c5f7c95348f20c1c913d72157b3c6dee6ea3e30b3d19502c5a7f6d3f160dacbf"
dependencies = [
"cc",
"windows-targets 0.52.6",

2
Cargo.toml
View file

@ -91,7 +91,7 @@ time = { version = "0.3.47", features = ["macros", "formatting"] }
tokio = { version = "1.49.0", features = ["full"] }
tokio-util = { version = "0.7.18", features = ["compat"] }
toml = "0.9.5"
tracy-client-sys = { version = "0.27.0", optional = true, default-features = false, features = [
tracy-client-sys = { version = "0.28.0", optional = true, default-features = false, features = [
"broadcast",
"delayed-init",
"enable",

40
website/docs/troubleshooting.md
View file

@ -44,25 +44,31 @@ when reporting bugs, [tracy](https://github.com/wolfpld/tracy) profiling data wi
useful and can usually help developers to troubleshoot the bug much faster. Here is how you can
collect tracy data.
1. *Install tracy.* Windows users can download it at
[its GitHub release page](https://github.com/wolfpld/tracy/releases). Linux and macOS users can
install it with package manager. Otherwise, you may have to build it yourself following tracy
docs.
1. _Install tracy._ Neovide's profiling build currently depends on
`tracy-client-sys 0.28.0`, which expects Tracy `v0.13.1` to work properly. An Older capture
binaries will fail with an "incompatible protocol version" error. Windows users can download
the correct version at [the Tracy release page](https://github.com/wolfpld/tracy/releases).
macOS and linux users can install it with package manager, but distro packages may lag behind
and ship an incompatible version.
If that happens, build Tracy `v0.13.1` yourself instead. If Neovide updates its Tracy
dependency later, please check `Cargo.toml` for the current `tracy-client-sys` version and
verify the matching Tracy release in the crate's compatibility
[table](https://github.com/nagisa/rust_tracy_client#version-support-table).
2. *Build a profiling version of Neovide.* Follow
[the installation page](https://neovide.dev/installation.html) to install all required
dependencies and Rust SDK. Download or clone
[source code of Neovide](https://github.com/neovide/neovide). Build it with following commands.
Note that you need to specify **both** `--profile profiling` and `--features profiling`, so that
Neovide is built for a profiling version. Or, you can skip these commands, and let `cargo run`
in step 5 build it automatically before running.
2. _Build a profiling version of Neovide._ Follow
[the installation page](https://neovide.dev/installation.html) to install all required
dependencies and Rust SDK. Download or clone
[source code of Neovide](https://github.com/neovide/neovide). Build it with following commands.
Note that you need to specify **both** `--profile profiling` and `--features profiling`, so that
Neovide is built for a profiling version. Or, you can skip these commands, and let `cargo run`
in step 5 build it automatically before running.
```sh
cd [neovide-source-dir]
cargo build --profile profiling --features profiling
```
3. *Prepare tracy for collecting data.* Start tracy with,
3. _Prepare tracy for collecting data._ Start tracy with,
```sh
tracy-capture -o [log-file-path]
@ -76,10 +82,10 @@ in step 5 build it automatically before running.
It means tracy begins to wait for Neovide and will capture profiling data once it starts.
4. *Running Neovide and reproduce the performance issue.* Start Neovide with following
commands in another terminal. If you have built Neovide with commands in step 3, this should
be very fast. If not, it will build Neovide first. You have to specify
`--profile profiling` and `--features profiling` here, too.
4. _Running Neovide and reproduce the performance issue._ Start Neovide with following
commands in another terminal. If you have built Neovide with commands in step 3, this should
be very fast. If not, it will build Neovide first. You have to specify
`--profile profiling` and `--features profiling` here, too.
```sh
cd [neovide-source-dir]
@ -88,7 +94,7 @@ be very fast. If not, it will build Neovide first. You have to specify
Now do whatever leads to performance issue in Neovide and exit.
5. *Get the tracy data and report bugs with it.* Turn to tracy, you will see output like,
5. _Get the tracy data and report bugs with it._ Turn to tracy, you will see output like,
```plain
Saving trace... done!