Clarification for memmory allocation function

Difference between g_try_... family of functions and their counterparts
has been clarified.

https://bugzilla.gnome.org/show_bug.cgi?id=792903
This commit is contained in:
Pavlo Solntsev 2018-01-25 10:41:30 -06:00 committed by Philip Withnall
parent 7e0d42e3dc
commit 382d13b618

View File

@ -63,8 +63,13 @@ static GMemVTable glib_mem_vtable = {
*
* These functions provide support for allocating and freeing memory.
*
* If any call to allocate memory fails, the application is terminated.
* This also means that there is no need to check if the call succeeded.
* 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()
* 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
* of functions returns %NULL on failure that can be used as a check
* for unsuccessful memory allocation. The application is not terminated
* in this case.
*
* 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