From: Matthias Clasen <mclasen@redhat.com>
Date: Mon, 19 Sep 2011 02:11:12 +0000 (-0400)
Subject: And move the g_thread_yield() docs too
X-Git-Tag: 2.31.0~432
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0ebd842d240f74cee6654e02beb15966b058c603;p=platform%2Fupstream%2Fglib.git

And move the g_thread_yield() docs too
---

diff --git a/glib/gthread-posix.c b/glib/gthread-posix.c
index 5e51634..52b8d3f 100644
--- 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)
 {