luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-25 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

gtestutils: Mention not ignoring SIGCHLD in g_test_trap_subprocess() docs

Browse Source 
Prompted by #3071, this clarifies that `g_test_trap_subprocess()` uses
`g_child_watch_source_new()` internally, so it will not work if any of
the preconditions for using that API are not met. In particular, if
`SIGCHLD` is ignored, things will break.

This documentation is not meant to be an API guarantee which constrains
the implementation of `g_test_trap_subprocess()` in future, just a tip
to people currently using the API.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3071
This commit is contained in:
Philip Withnall 2023-08-17 14:59:28 +01:00
parent 77a56b58ed
commit 15022cab15
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
glib/gtestutils.c
View File

@ -4067,6 +4067,11 @@ G_GNUC_END_IGNORE_DEPRECATIONS
* the subprocess, you can call g_test_subprocess() (after calling
* g_test_init()) to see whether you are in a subprocess.
*
* Internally, this function tracks the child process using
* g_child_watch_source_new(), so your process must not ignore `SIGCHLD`, and
* must not attempt to watch or wait for the child process via another
* mechanism.
*
* The following example tests that calling
* `my_object_new(1000000)` will abort with an error
* message.