Updated.

2001-05-08  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>

	* glib/tmpl/threads.sgml, glib/glib-overrides.txt: Updated.

diff --git a/ChangeLog b/ChangeLog
index 848460d..002b426 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-0
+++ b/ChangeLog.pre-2-0
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-2
+++ b/ChangeLog.pre-2-2
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-4
+++ b/ChangeLog.pre-2-4
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 848460d..002b426 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -9,7 +9,7 @@
        returned by g_thread_join and is either the return of the topmost
        thread function or the value given to g_thread_exit.
        
-       * gthreadpool.c, tests/mainloop-test.c, test/thread-test.c:
+       * gthreadpool.c, tests/mainloop-test.c, tests/thread-test.c:
        Adapted to the above change.
 
 2001-01-06  Hans Breuer  <hans@breuer.org>

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 3e8ef0f..283e7d7 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2001-05-08  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
+
+       * glib/tmpl/threads.sgml, glib/glib-overrides.txt: Updated.
+
 2001-04-19  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
 
        * glib/tmpl/hash_tables.sgml, glib/tmpl/misc_utils.sgml,

diff --git a/docs/reference/glib/glib-overrides.txt b/docs/reference/glib/glib-overrides.txt
index a1dce71..7068575 100644 (file)
--- a/docs/reference/glib/glib-overrides.txt
+++ b/docs/reference/glib/glib-overrides.txt
@@ -98,11 +98,6 @@ GStaticMutex* mutex
 <RETURNS>void</RETURNS>
 </FUNCTION>
 
-<FUNCTION>
-<NAME>g_thread_exit</NAME>
-<RETURNS>void</RETURNS>
-</FUNCTION>
-
 # G_LOCK_* macros
 
 <MACRO>

diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml
index 3d75a90..3fbb1c3 100644 (file)
--- a/docs/reference/glib/tmpl/threads.sgml
+++ b/docs/reference/glib/tmpl/threads.sgml
@@ -224,6 +224,8 @@ g_thread_create().
 </para>
 
 @value: data supplied to the thread
+@Returns: the return value of the thread, which will be returned by
+g_thread_join()
 
 
 <!-- ##### ENUM GThreadPriority ##### -->
@@ -263,6 +265,8 @@ g_thread_join() is called for that thread.
 @joinable: is this thread joinable?
 @bound: is this thread bound to a system thread?
 @priority: the priority of the thread
+@func: the function executing in that thread
+@arg: the argument to the function
 
 <!-- ##### FUNCTION g_thread_create ##### -->
 <para>
@@ -325,10 +329,12 @@ Waits until @thread finishes, i.e. the function @thread_func, as given
 to g_thread_create, returns or g_thread_exit() is called by
 @thread. All resources of @thread including the #GThread struct are
 released. @thread must have been created with @joinable=#TRUE in
-g_thread_create().
+g_thread_create(). The value returned by @thread_func or given to
+g_thread_exit() by @thread is returned by this function.
 </para>
 
 @thread: a #GThread to be waited for
+@Returns: the return value of the thread
 
 
 <!-- ##### FUNCTION g_thread_set_priority ##### -->
@@ -366,7 +372,34 @@ to do that. So in general you shouldn't use that function.
 <!-- ##### FUNCTION g_thread_exit ##### -->
 <para>
 Exit the current thread. If another thread is waiting for that thread
-using g_thread_join(), that thread will be woken up. 
+using g_thread_join() and the current thread is joinable, the waiting
+thread will be woken up and getting @retval as the return value of
+g_thread_join(). If the current thread is not joinable, @retval is
+ignored. Calling
+</para>
+
+<para>
+<informalexample>
+<programlisting>
+g_thread_join (retval);
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+is equivalent to calling 
+</para>
+
+<para>
+<informalexample>
+<programlisting>
+return retval;
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+in the function @thread_func, as given to g_thread_create().
 </para>
 
 <note>
@@ -377,6 +410,7 @@ results.
 </para>
 </note>
 
+@retval: the return value of this thread
 
 
 <!-- ##### STRUCT GMutex ##### -->