bk commit into 4.1 tree (msvensson:1.2473)

[msvensson]

Below is the list of changes that have just been committed into a local
4.1 repository of msvensson. When msvensson does a push these changes will
be propagated to the main repository and, within 24 hours after the
push, to the public repository.
For information on how to access the public repository
see http://dev.mysql.com/doc/mysql/en/installing-source-tree.html

ChangeSet
  1.2473 06/05/23 10:33:53 msvensson@neptunus.(none) +1 -0
  Add comment for 'kill_server' function

  sql/mysqld.cc
    1.613 06/05/23 10:33:50 msvensson@neptunus.(none) +14 -1
    Add comment for 'kill_server' function

# This is a BitKeeper patch.  What follows are the unified diffs for the
# set of deltas contained in the patch.  The rest of the patch, the part
# that BitKeeper cares about, is below these diffs.
# User:	msvensson
# Host:	neptunus.(none)
# Root:	/home/msvensson/mysql/my41-bug13711

--- 1.612/sql/mysqld.cc	2006-05-19 13:07:20 +02:00
+++ 1.613/sql/mysqld.cc	2006-05-23 10:33:50 +02:00
@@ -863,7 +863,20 @@
   DBUG_VOID_RETURN;
 }
 
-	/* Force server down. kill all connections and threads and exit */
+/*
+  Force server down. Kill all connections and threads and exit
+
+  SYNOPSIS
+  kill_server
+
+  sig_ptr       Signal number that caused kill_server to be called.
+
+  NOTE!
+    A signal number of 0 mean that the function was not called
+    from a signal handler and there is thus no signal to block
+    or stop, we just want to kill the server.
+
+*/
 
 #if defined(OS2) || defined(__NETWARE__)
 extern "C" void kill_server(int sig_ptr)