glist: Clarify that g_list_free() and friends only free an entire list

They shouldn’t be used to free a list from part-way through, as that
is confusing and will leave a dangling pointer from the previous list
element.

Spotted by Gary Kramlich in !1653.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
This commit is contained in:
Philip Withnall 2020-09-22 16:41:55 +01:00
parent 76dfe085e4
commit eb19c328f3
2 changed files with 4 additions and 4 deletions

View File

@ -173,7 +173,7 @@ g_list_alloc (void)
/**
* g_list_free:
* @list: a #GList
* @list: the first link of a #GList
*
* Frees all of the memory used by a #GList.
* The freed elements are returned to the slice allocator.
@ -217,7 +217,7 @@ g_list_free_1 (GList *list)
/**
* g_list_free_full:
* @list: a pointer to a #GList
* @list: the first link of a #GList
* @free_func: the function to be called to free each element's data
*
* Convenience method, which frees all the memory used by a #GList,

View File

@ -127,7 +127,7 @@ g_slist_alloc (void)
/**
* g_slist_free:
* @list: a #GSList
* @list: the first link of a #GSList
*
* Frees all of the memory used by a #GSList.
* The freed elements are returned to the slice allocator.
@ -171,7 +171,7 @@ g_slist_free_1 (GSList *list)
/**
* g_slist_free_full:
* @list: a pointer to a #GSList
* @list: the first link of a #GSList
* @free_func: the function to be called to free each element's data
*
* Convenience method, which frees all the memory used by a #GSList, and