Add comment for 'kill_server' function

1 files changed, 14 insertions, 1 deletions

diff --git a/sql/mysqld.cc b/sql/mysqld.cc
index 9c1089dbdb2..fc3ca5085cf 100644
--- a/sql/mysqld.cc
+++ b/sql/mysqld.cc
@@ -863,7 +863,20 @@ void kill_mysql(void)
   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)