# HG changeset patch
# User jlarmour
# Date 1078366674 0
# Node ID 382e69fac9e0f19bbdbec9c2ee8fbd661476ec09
# Parent  970d06598f83ae8c844c9e3efb44b063c3abb1e2
	* doc/kernel.sgml: Document cyg_thread_delete return value.

diff --git a/packages/kernel/current/ChangeLog b/packages/kernel/current/ChangeLog
--- a/packages/kernel/current/ChangeLog
+++ b/packages/kernel/current/ChangeLog
@@ -1,3 +1,7 @@
+2004-03-04  Jonathan Larmour  <jifl@eCosCentric.com>
+
+	* doc/kernel.sgml: Document cyg_thread_delete return value.
+
 2004-02-19  Jonathan Larmour  <jifl@eCosCentric.com>
 
 	* tests/kmutex3.c (cyg_start): Use CYG_TEST_NA.
diff --git a/packages/kernel/current/doc/kernel.sgml b/packages/kernel/current/doc/kernel.sgml
--- a/packages/kernel/current/doc/kernel.sgml
+++ b/packages/kernel/current/doc/kernel.sgml
@@ -1665,7 +1665,7 @@ DSR context.
           <paramdef>cyg_handle_t <parameter>thread</parameter></paramdef>
         </funcprototype>
         <funcprototype>
-          <funcdef>void <function>cyg_thread_delete</function></funcdef>
+          <funcdef>cyg_bool_t <function>cyg_thread_delete</function></funcdef>
           <paramdef>cyg_handle_t <parameter>thread</parameter></paramdef>
         </funcprototype>
       </funcsynopsis>
@@ -1717,7 +1717,12 @@ thread handle is no longer valid, and bo
 <structname>cyg_thread</structname> structure and the thread stack can
 be re-used or freed. If <function>cyg_thread_delete</function> is
 invoked on a thread that is still running then there is an implicit
-call to <function>cyg_thread_kill</function>.
+call to <function>cyg_thread_kill</function>. This function returns
+<literal>true</literal> if the delete was successful, and
+<literal>false</literal> if the delete did not happen. The delete
+may not happen for example if the thread being destroyed is a lower
+priority thread than the running thread, and will thus not wake up
+in order to exit until it is rescheduled.
       </para>
     </refsect1>