And move the g_thread_yield() docs too

diff --git a/glib/gthread-posix.c b/glib/gthread-posix.c
index 5e51634..52b8d3f 100644 (file)
--- a/glib/gthread-posix.c
+++ b/glib/gthread-posix.c
@@ -629,6 +629,15 @@ g_thread_create_posix_impl (GThreadFunc thread_func,
   posix_check_err (ret, "pthread_create");
 }
 
+/**
+ * g_thread_yield:
+ *
+ * Gives way to other threads waiting to be scheduled.
+ *
+ * This function is often used as a method to make busy wait less evil.
+ * But in most cases you will encounter, there are better methods to do
+ * that. So in general you shouldn't use this function.
+ */
 void
 g_thread_yield (void)
 {