Update the docs around profiling

Mention sysprof-cli, and stop mentioning GTK_TRACE_FD.
This commit is contained in:
Matthias Clasen 2020-08-20 17:46:53 -04:00
parent d4e069a629
commit 40f3da19ae

View File

@ -335,17 +335,13 @@ GSettings schema.
## Profiling {#profiling} ## Profiling {#profiling}
GTK supports profiling with sysprof. It exports timing information GTK supports profiling with sysprof. It exports timing information
about frameclock phases and various characteristics of GskRenders about frameclock phases and various characteristics of GskRenderers
in a format that can be displayed by sysprof or GNOME Builder. in a format that can be displayed by sysprof or GNOME Builder.
A simple way to capture data is to set the `GTK_TRACE` environment A simple way to capture data is to run your application under the
variable. When it is set, GTK will write profiling data to a file `sysprof-cli` wrapper, which will write profiling data to a file
called `gtk.PID.syscap`. called `capture.syscap`.
When launching the application from sysprof, it will set the When launching the application from sysprof, it will set the
`SYSPROF_TRACE_FD` environment variable to point GTK at a file `SYSPROF_TRACE_FD` environment variable to point GTK at a file
descriptor to write profiling data to. descriptor to write profiling data to.
When GtkApplication registers with D-Bus, it exports the
`org.gnome.Sysprof2.Profiler` D-Bus interface that lets sysprof
request profiling data at runtime.