luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-03 14:23:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

gmem: Improve documentation to clarify abort-on-alloc-failure

Browse Source 
Clarify that it applies to everything.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Fixes:
This commit is contained in:
Philip Withnall 2020-05-19 15:12:16 +01:00
parent 81ee85c793
commit 445aa65e90
1 changed files with 5 additions and 1 deletions

6
glib/gmem.c

@ -66,11 +66,15 @@ static GMemVTable glib_mem_vtable = {
* If any call to allocate memory using functions g_new(), g_new0(), g_renew(), * If any call to allocate memory using functions g_new(), g_new0(), g_renew(),
* g_malloc(), g_malloc0(), g_malloc0_n(), g_realloc(), and g_realloc_n() * g_malloc(), g_malloc0(), g_malloc0_n(), g_realloc(), and g_realloc_n()
* fails, the application is terminated. This also means that there is no * fails, the application is terminated. This also means that there is no
* need to check if the call succeeded. On the other hand, g_try_...() family * need to check if the call succeeded. On the other hand, the `g_try_...()` family
* of functions returns %NULL on failure that can be used as a check * of functions returns %NULL on failure that can be used as a check
* for unsuccessful memory allocation. The application is not terminated * for unsuccessful memory allocation. The application is not terminated
* in this case. * in this case.
* *
* As all GLib functions and data structures use `g_malloc()` internally, unless
* otherwise specified, any allocation failure will result in the application
* being terminated.
*
* It's important to match g_malloc() (and wrappers such as g_new()) with * It's important to match g_malloc() (and wrappers such as g_new()) with
* g_free(), g_slice_alloc() (and wrappers such as g_slice_new()) with * g_free(), g_slice_alloc() (and wrappers such as g_slice_new()) with
* g_slice_free(), plain malloc() with free(), and (if you're using C++) * g_slice_free(), plain malloc() with free(), and (if you're using C++)