leaks: add unix signals documentation

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4973>
This commit is contained in:
Andoni Morales Alastruey 2023-07-05 16:50:07 +02:00 committed by GStreamer Marge Bot
parent 893e4ed0dd
commit 20c6d8c78f

View file

@ -27,10 +27,16 @@
* objects and prints a list of leaks to the debug log under `GST_TRACER:7` when
* gst_deinit() is called, and also prints a g_warning().
*
* Starting with GStreamer 1.18, you can also use action signals on the tracer
* Starting with GStreamer 1.18, you can also use GObject action signals on the tracer
* object to fetch leak information. Use gst_tracing_get_active_tracers() to
* get a list of all active tracers and find the right one by name.
*
* If the `GST_LEAKS_TRACER_SIG` env variable is defined, you can use the
* following POSIX signals to interact with the leaks tracer:
* - SIGUSR1: log alive objects
* - SIGUSR2: create a checkpoint and print a list of objects created and
* destroyed since the previous checkpoint.
*
* You can activate this tracer in the usual way by adding the string 'leaks'
* to the environment variable `GST_TRACERS`. Such as: `GST_TRACERS=leaks`
*