bk commit into 5.1 tree (mats:1.2547) BUG#25688

[Mats Kindahl]

Below is the list of changes that have just been committed into a local
5.1 repository of mats. When mats 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-04-12 08:56:07+02:00, mats@romeo.(none) +1 -0
  BUG#25688 (RBR: circular replication may cause STMT_END_F flags
  to be skipped):
  
  Documentation fixes.

  sql/rpl_rli.h@stripped, 2007-04-12 08:56:03+02:00, mats@romeo.(none) +11 -7
    Fixing documentation

# 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:	mats
# Host:	romeo.(none)
# Root:	/home/bk/b25688-mysql-5.1-rpl

--- 1.12/sql/rpl_rli.h	2007-04-12 08:56:17 +02:00
+++ 1.13/sql/rpl_rli.h	2007-04-12 08:56:17 +02:00
@@ -327,18 +327,22 @@
   time_t last_event_start_time;
 
   /**
-    Helper function to after statement completion.
+    Helper function to do after statement completion.
 
-    This function will complete the group by stepping the group
-    position if the "statement" is not inside a transaction. If the
-    "statement" is inside a transaction, the function will just
-    increase the event position.
+    This function is called from an event to complete the group by
+    either stepping the group position, if the "statement" is not
+    inside a transaction; or increase the event position, if the
+    "statement" is inside a transaction.
 
     @param event_log_pos
-    Master log position of the event
+    Master log position of the event. The position is recorded in the
+    relay log info and used to produce information for <code>SHOW
+    SLAVE STATUS</code>.
 
     @param event_creation_time
-    Timestamp for the creation of the event on the master side
+    Timestamp for the creation of the event on the master side. The
+    time stamp is recorded in the relay log info and used to compute
+    the <code>Seconds_behind_master</code> field.
   */
   void stmt_done(my_off_t event_log_pos,
                  time_t event_creation_time);