diff --git a/steam-runtime-tools/system-info.c b/steam-runtime-tools/system-info.c index 016269b8de3005d40167fe1f1e838bd93d19d5e2..29bfd401f71fbec8b975b6559423325a85e86cd5 100644 --- a/steam-runtime-tools/system-info.c +++ b/steam-runtime-tools/system-info.c @@ -66,6 +66,14 @@ * Other threads may create their own parallel #SrtSystemInfo object and * use that instead, if desired. * + * The majority of the #SrtSystemInfo API involves child processes, and + * requires `SIGCHLD` to be handled (somehow) by the host process: + * `SIGCHLD` must not have been ignored (by `sigaction(2)` with `SIG_IGN`) + * or blocked (for example with `sigprocmask(2)`) in the thread that is + * acting on the #SrtSystemInfo. If this cannot be guaranteed, please run + * `steam-runtime-system-info(1)` as a child process and inspect its + * JSON output instead of calling library functions directly. + * * Ownership can be transferred to other threads by an operation that * implies a memory barrier, such as g_atomic_pointer_set() or * g_object_ref(), but after this is done the previous owner must not