Updated.

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

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

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a2c9946..d9f3a75 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2001-05-18  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
+
+       * glib/glib-overrides.txt, glib/glib-sections.txt,
+       glib/tmpl/thread_pools.sgml, glib/tmpl/threads.sgml: Updated.
+
 2001-05-09  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
 
        * glib/tmpl/thread_pools.sgml, glib/tmpl/thread_pools.sgml:

diff --git a/docs/reference/glib/glib-overrides.txt b/docs/reference/glib/glib-overrides.txt
index 7068575..80fe2f1 100644 (file)
--- a/docs/reference/glib/glib-overrides.txt
+++ b/docs/reference/glib/glib-overrides.txt
@@ -98,6 +98,15 @@ GStaticMutex* mutex
 <RETURNS>void</RETURNS>
 </FUNCTION>
 
+<FUNCTION>
+<NAME>g_thread_create</NAME>
+<RETURNS>GThread *</RETURNS>
+GThreadFunc func
+gpointer data,
+gboolean joinable,
+GError **error
+</FUNCTION>
+
 # G_LOCK_* macros
 
 <MACRO>

diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt
index ad5118b..a842911 100644 (file)
--- a/docs/reference/glib/glib-sections.txt
+++ b/docs/reference/glib/glib-sections.txt
@@ -443,6 +443,7 @@ GThreadFunc
 GThreadPriority
 GThread
 g_thread_create
+g_thread_create_full
 g_thread_self
 g_thread_join
 g_thread_set_priority

diff --git a/docs/reference/glib/tmpl/thread_pools.sgml b/docs/reference/glib/tmpl/thread_pools.sgml
index a23090d..f31bcc7 100644 (file)
--- a/docs/reference/glib/tmpl/thread_pools.sgml
+++ b/docs/reference/glib/tmpl/thread_pools.sgml
@@ -68,8 +68,6 @@ this struct.
 
 @func: the function to execute in the threads of this pool
 @user_data: the user data for the threads of this pool
-@bound: are the threads of this pool bound?
-@priority: the priority of the threads of this pool
 @exclusive: are all threads exclusive to this pool
 
 <!-- ##### FUNCTION g_thread_pool_new ##### -->
@@ -80,14 +78,9 @@ this struct.
 @func: 
 @user_data: 
 @max_threads: 
-@stack_size: 
-@bound: 
-@priority: 
 @exclusive: 
 @error: 
 @Returns: 
-<!-- # Unused Parameters # -->
-@thread_func: 
 
 
 <!-- ##### FUNCTION g_thread_pool_push ##### -->

diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml
index 91a9bbf..5dbbb17 100644 (file)
--- a/docs/reference/glib/tmpl/threads.sgml
+++ b/docs/reference/glib/tmpl/threads.sgml
@@ -220,7 +220,7 @@ you can however use it as if it was a function.
 <!-- ##### USER_FUNCTION GThreadFunc ##### -->
 <para>
 Specifies the type of the @func functions passed to
-g_thread_create().
+g_thread_create() or g_thread_create_full().
 </para>
 
 @data: data passed to the thread
@@ -265,11 +265,38 @@ g_thread_join() is called for that thread.
 @func: the function executing in that thread
 @data: the argument to the function
 @joinable: is this thread joinable?
-@bound: is this thread bound to a system thread?
 @priority: the priority of the thread
 
 <!-- ##### FUNCTION g_thread_create ##### -->
 <para>
+This function creates a new thread with the priority @priority.
+</para>
+
+<para>
+If @joinable is #TRUE, you can wait for this threads termination
+calling g_thread_wait(). Otherwise the thread will just disappear, when
+ready. 
+</para>
+
+<para>
+The new thread executes the function @func with the argument
+@data. If the thread was created successfully, it is returned.
+</para>
+
+<para>
+@error can be NULL to ignore errors, or non-NULL to report errors. The
+error is set, if and only if the function returns #NULL.
+</para>
+
+@func: a function to execute in the new thread
+@data: an argument to supply to the new thread
+@joinable: should this thread be joinable?
+@error: return location for error.
+@Returns: the new #GThread on success
+
+
+<!-- ##### FUNCTION g_thread_create_full ##### -->
+<para>
 This function creates a new thread with the priority @priority. The
 stack gets the size @stack_size or the default value for the current
 platform, if @stack_size is 0.
@@ -305,6 +332,15 @@ default.
 </para>
 </note>
 
+<note>
+<para>
+Only use g_thread_create_full(), when you really can't use
+g_thread_create() instead. g_thread_create() does not take
+@stack_size, @bound and @priority as arguments, as they should only be
+used for cases, where it is inevitable. 
+</para>
+</note>
+
 @func: a function to execute in the new thread
 @data: an argument to supply to the new thread
 @stack_size: a stack size for the new thread