bk commit into 5.1 tree (cmiller:1.2517)

[Chad MILLER]

Below is the list of changes that have just been committed into a local
5.1 repository of cmiller. When cmiller 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@stripped, 2007-05-22 11:20:50-04:00, cmiller@stripped +17 -0
  Further merge fixups and Doxygen syntax fixes.

  sql/events.h@stripped, 2007-05-22 11:20:46-04:00, cmiller@stripped +2 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/filesort.cc@stripped, 2007-05-22 11:20:46-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/item_cmpfunc.cc@stripped, 2007-05-22 11:20:46-04:00, cmiller@stripped +0 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/item_sum.h@stripped, 2007-05-22 11:20:46-04:00, cmiller@stripped +1 -0
    Further merge fixups and Doxygen syntax fixes.

  sql/lock.cc@stripped, 2007-05-22 11:20:46-04:00, cmiller@stripped +0 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/mysql_priv.h@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/mysqld.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/parse_file.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/password.c@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/protocol.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +0 -2
    Further merge fixups and Doxygen syntax fixes.

  sql/set_var.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +3 -2
    Further merge fixups and Doxygen syntax fixes.

  sql/set_var.h@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +3 -2
    Further merge fixups and Doxygen syntax fixes.

  sql/sp.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -2
    Further merge fixups and Doxygen syntax fixes.

  sql/sp_head.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +2 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/sql_db.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/sql_parse.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +1 -1
    Further merge fixups and Doxygen syntax fixes.

  sql/sql_plugin.cc@stripped, 2007-05-22 11:20:47-04:00, cmiller@stripped +2 -2
    Further merge fixups and Doxygen syntax fixes.

# 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:	cmiller
# Host:	zippy.cornsilk.net
# Root:	/home/cmiller/work/mysql/doxygen-application/mysql-5.1-doxygen-col

--- 1.128/sql/filesort.cc	2007-05-18 16:02:15 -04:00
+++ 1.129/sql/filesort.cc	2007-05-22 11:20:46 -04:00
@@ -79,7 +79,7 @@ static void unpack_addon_fields(struct s
   @param sortorder	How to sort the table
   @param s_length	Number of elements in sortorder
   @param select		condition to apply to the rows
-  @param ha_maxrows	Return only this many rows
+  @param max_rows	Return only this many rows
   @param sort_positions	Set to 1 if we want to force sorting by position
 			(Needed by UPDATE/INSERT or ALTER TABLE)
   @param examined_rows	Store number of examined rows here

--- 1.274/sql/item_cmpfunc.cc	2007-05-18 16:02:16 -04:00
+++ 1.275/sql/item_cmpfunc.cc	2007-05-22 11:20:46 -04:00
@@ -115,7 +115,6 @@ static int cmp_row_type(Item* item1, Ite
     supposed to be used later for comparison of values of these items.
     Aggregation itself is performed by the item_cmp_type() function.
 
-  @param      thd          thread handle
   @param[out] type    the aggregated type
   @param      items        array of items to aggregate the type from
   @param      nitems       number of items in the array

--- 1.119/sql/item_sum.h	2007-05-18 16:02:16 -04:00
+++ 1.120/sql/item_sum.h	2007-05-22 11:20:46 -04:00
@@ -753,6 +753,7 @@ But, this falls prey to catastrophic can
   for 2 <= k <= n newline
   ital variance = S_{n} / (n-1)
 
+  @endverbatim
 */
 
 class Item_sum_variance : public Item_sum_num

--- 1.107/sql/lock.cc	2007-05-18 16:02:16 -04:00
+++ 1.108/sql/lock.cc	2007-05-22 11:20:46 -04:00
@@ -62,7 +62,6 @@
 
   - When calling UNLOCK TABLES we call mysql_unlock_tables() for all
     tables used in LOCK TABLES
- @endverbatim
 
  @todo
     Change to use my_malloc() ONLY when using LOCK TABLES command or when

--- 1.506/sql/mysql_priv.h	2007-05-18 16:02:17 -04:00
+++ 1.507/sql/mysql_priv.h	2007-05-22 11:20:47 -04:00
@@ -19,7 +19,7 @@
   @details
   Mostly this file is used in the server. But a little part of it is used in
   mysqlbinlog too (definition of SELECT_DISTINCT and others).
-  The consequence is that 90% of the file is wrapped in #ifndef MYSQL_CLIENT,
+  The consequence is that 90% of the file is wrapped in \#ifndef MYSQL_CLIENT,
   except the part which must be in the server and in the client.
 */
 

--- 1.645/sql/mysqld.cc	2007-05-18 16:02:17 -04:00
+++ 1.646/sql/mysqld.cc	2007-05-22 11:20:47 -04:00
@@ -4294,7 +4294,7 @@ void create_thread_to_handle_connection(
     connection.  If there are idle cached threads one will be used.
     'thd' will be pushed into 'threads'.
 
-    In single-threaded mode (#define ONE_THREAD) connection will be
+    In single-threaded mode (\#define ONE_THREAD) connection will be
     handled inside this function.
 
   @param[in,out] thd    Thread handle of future thread.

--- 1.128/sql/protocol.cc	2007-05-18 16:02:17 -04:00
+++ 1.129/sql/protocol.cc	2007-05-22 11:20:47 -04:00
@@ -339,8 +339,6 @@ static char eof_buff[1]= { (char) 254 };
   client.
 
   @param thd		Thread handler
-  @param no_flush	Set to 1 if there will be more data to the client,
-                       like in send_fields().
 */
 
 void

--- 1.45/sql/password.c	2007-05-18 16:02:17 -04:00
+++ 1.46/sql/password.c	2007-05-22 11:20:47 -04:00
@@ -470,7 +470,7 @@ scramble(char *to, const char *message, 
     null-terminated, reply and hash_stage2 must be at least SHA1_HASH_SIZE
     long (if not, something fishy is going on).
 
-  @param[in] scramble     clients' reply, presumably produced by scramble()
+  @param[in] scramble_arg clients' reply, presumably produced by scramble()
   @param[in] message      original random string, previously sent to client
     (presumably second argument of scramble()), must be
     exactly SCRAMBLE_LENGTH long and NULL-terminated.

--- 1.151/sql/sql_db.cc	2007-04-13 03:25:27 -04:00
+++ 1.152/sql/sql_db.cc	2007-05-22 11:20:47 -04:00
@@ -1324,7 +1324,7 @@ static void mysql_change_db_impl(THD *th
   @brief Change the current database.
 
   @param thd          thread handle
-  @param name         database name
+  @param new_db_name  database name
   @param force_switch if this flag is set (TRUE), mysql_change_db() will
                       switch to NULL db if the specified database is not
                       available anymore. Corresponding warning will be

--- 1.667/sql/sql_parse.cc	2007-05-18 16:02:18 -04:00
+++ 1.668/sql/sql_parse.cc	2007-05-22 11:20:47 -04:00
@@ -5925,7 +5925,7 @@ void st_select_lex::set_lock_for_tables(
     (SELECT ... ORDER BY LIMIT n) ORDER BY ...
     @endvarbatim
 
-  @param thd			   thread handle
+  @param thd_arg		   thread handle
 
   @note
     The object is used to retrieve rows from the temporary table

--- 1.55/sql/events.h	2007-04-05 12:47:18 -04:00
+++ 1.56/sql/events.h	2007-05-22 11:20:46 -04:00
@@ -42,7 +42,8 @@ int
 sortcmp_lex_string(LEX_STRING s, LEX_STRING t, CHARSET_INFO *cs);
 
 /**
-  @class Events -- a facade to the functionality of the Event Scheduler.
+  @class
+  Events -- a facade to the functionality of the Event Scheduler.
 
   Every public operation against the scheduler has to be executed via the
   interface provided by a static method of this class. No instance of this

--- 1.29/sql/parse_file.cc	2007-05-18 16:02:17 -04:00
+++ 1.30/sql/parse_file.cc	2007-05-22 11:20:47 -04:00
@@ -198,7 +198,7 @@ write_parameter(IO_CACHE *file, gptr bas
   Write new .frm.
 
   @param dir           directory where put .frm
-  @param file          .frm file name
+  @param file_name     .frm file name
   @param type          .frm type string (VIEW, TABLE)
   @param base          base address for parameter reading (structure like
                        TABLE)

--- 1.232/sql/set_var.cc	2007-05-18 16:02:17 -04:00
+++ 1.233/sql/set_var.cc	2007-05-22 11:20:47 -04:00
@@ -2909,9 +2909,10 @@ int mysql_append_static_vars(const SHOW_
 /**
   Find a user set-table variable.
 
-  @param str	    Name of system variable to find
+  @param str	   Name of system variable to find
   @param length    Length of variable.  zero means that we should use strlen()
                    on the variable
+  @param no_error  Refuse to emit an error, even if one occurred.
 
   @retval
     pointer	pointer to variable definitions
@@ -2946,7 +2947,7 @@ sys_var *intern_find_sys_var(const char 
   updated.
 
   @param THD		Thread id
-  @param set_var	List of variables to update
+  @param var_list       List of variables to update
 
   @retval
     0	ok

--- 1.107/sql/set_var.h	2007-05-18 16:02:17 -04:00
+++ 1.108/sql/set_var.h	2007-05-22 11:20:47 -04:00
@@ -14,7 +14,8 @@
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */
 
 /**
-  @file Classes to support the SET command
+  @file
+  Classes to support the SET command.
 */
 
 #ifdef USE_PRAGMA_INTERFACE
@@ -1063,7 +1064,7 @@ public:
 
 
 /**
-  User variables like @my_own_variable.
+  User variables like \@my_own_variable.
 */
 
 class set_var_user: public set_var_base

--- 1.64/sql/sql_plugin.cc	2007-05-10 02:06:06 -04:00
+++ 1.65/sql/sql_plugin.cc	2007-05-22 11:20:47 -04:00
@@ -2411,9 +2411,9 @@ void plugin_thdvar_cleanup(THD *thd)
 
 
 /**
-  @brief Free values of thread variables of a plugin.
+  Free values of thread variables of a plugin.
 
-  @detail This must be called before a plugin is deleted. Otherwise its
+  This must be called before a plugin is deleted. Otherwise its
   variables are no longer accessible and the value space is lost. Note
   that only string values with PLUGIN_VAR_MEMALLOC are allocated and
   must be freed.

--- 1.149/sql/sp.cc	2007-05-18 16:02:17 -04:00
+++ 1.150/sql/sp.cc	2007-05-22 11:20:47 -04:00
@@ -1626,7 +1626,6 @@ sp_cache_routines_and_add_tables_aux(THD
   @param lex               LEX representing statement
   @param first_no_prelock  If true, don't add tables or cache routines used by
                            the body of the first routine (i.e. *start)
-  @param tabs_changed      Set to TRUE some tables were added, FALSE otherwise
 
   @retval
     0       success
@@ -1804,7 +1803,7 @@ create_string(THD *thd, String *buf,
                         database, length contains the size of the buffer.
                     [OUT] if old db was not NULL, its name is copied
                     to the buffer pointed at by str and length is updated
-                    accordingly. Otherwise str[0] is set to '\0' and length
+                    accordingly. Otherwise str[0] is set to '\\0' and length
                     is set to 0. The out parameter should be used only if
                     the database name has been changed (see dbchangedp).
   @param dbchangedp [OUT] is set to TRUE if the current database is changed,

--- 1.267/sql/sp_head.cc	2007-05-18 16:02:17 -04:00
+++ 1.268/sql/sp_head.cc	2007-05-22 11:20:47 -04:00
@@ -81,6 +81,7 @@ sp_map_item_type(enum enum_field_types t
 /**
   Return a string representation of the Item value.
 
+  @param thd     thread handle
   @param str     string buffer for representation of the value
 
   @note
@@ -308,8 +309,8 @@ sp_prepare_func_item(THD* thd, Item **it
   Evaluate an expression and store the result in the field.
 
   @param thd                    current thread object
-  @param expr_item              the root item of the expression
   @param result_field           the field to store the result
+  @param expr_item_ptr          the root item of the expression
 
   @retval
     FALSE  on success