From c6312daba0418e384b9ee64917861225a85edacf Mon Sep 17 00:00:00 2001
From: Philip Withnall <philip.withnall@collabora.co.uk>
Date: Fri, 19 Dec 2014 18:53:22 +0000
Subject: [PATCH] glist: Clarify how g_list_free_1() handles links
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

It doesn’t, which is fine, but could be unexpected if undocumented.

https://bugzilla.gnome.org/show_bug.cgi?id=741779
---
 glib/glist.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/glib/glist.c b/glib/glist.c
index 2f3a49bfb..1639a9f92 100644
--- a/glib/glist.c
+++ b/glib/glist.c
@@ -186,7 +186,10 @@ g_list_free (GList *list)
  * g_list_free_1:
  * @list: a #GList element
  *
- * Frees one #GList element.
+ * Frees one #GList element, but does not update links from the next and
+ * previous elements in the list, so you should not call this function on an
+ * element that is currently part of a list.
+ *
  * It is usually used after g_list_remove_link().
  */
 /**