gstdio: Improve documentation of g_close() as async-signal safe

Add cross-references as requested for similar new API in !3457.

Signed-off-by: Simon McVittie <smcv@collabora.com>
This commit is contained in:
Simon McVittie 2023-05-31 16:24:01 +01:00
parent 7a82da2992
commit 9af6b7e4e7

View File

@ -1760,8 +1760,12 @@ g_utime (const gchar *filename,
*
* It is a bug to call this function with an invalid file descriptor.
*
* Since 2.76, this function is guaranteed to be async-signal-safe if (and only
* if) @error is %NULL and @fd is a valid open file descriptor.
* On POSIX platforms since GLib 2.76, this function is async-signal safe
* if (and only if) @error is %NULL and @fd is a valid open file descriptor.
* This makes it safe to call from a signal handler or a #GSpawnChildSetupFunc
* under those conditions.
* See [`signal(7)`](man:signal(7)) and
* [`signal-safety(7)`](man:signal-safety(7)) for more details.
*
* Returns: %TRUE on success, %FALSE if there was an error.
*