Merge lp:~hrvojem/percona-xtrabackup/bug1065761-2.0 into lp:percona-xtrabackup/2.0

[Hrvoje Matijakovic]

[Alexey Kopytov (akopytov)]

Hrvoje,

Do we really have to duplicate all info from http://www.percona.com/doc/percona-xtrabackup/innobackupex/creating_a_backup_ibk.html on a separate page? Can we link one from another?

If we do have to duplicate it, I would exclude "mysql-stderr" and "mysql-stdout" (those are temporary "under the hood" files which are NOT a part of backup).

I would also improve descriptions for other files, but that should probably be filed and fixed separately.

review: Needs Information

[Hrvoje Matijakovic (hrvojem)]

I've linked the content from innobackupex page to the the index and removed the "mysql-stderr" and "mysql-stdout".

[Alexey Kopytov (akopytov)]

review: Approve

=== modified file 'doc/source/howtos/setting_up_replication.rst'
--- doc/source/howtos/setting_up_replication.rst	2012-02-02 20:22:08 +0000
+++ doc/source/howtos/setting_up_replication.rst	2012-10-24 18:50:26 +0000
@@ -231,7 +231,7 @@
 .. code-block:: mysql
 
    TheNEWSlave|mysql> CHANGE MASTER TO 
-                      MASTER_HOST='$masterip'
+                      MASTER_HOST='$masterip',
                       MASTER_USER='repl',
                       MASTER_PASSWORD='$slavepass',
                       MASTER_LOG_FILE='TheMaster-bin.000001', 
 
=== modified file 'doc/source/index.rst'
--- doc/source/index.rst	2012-02-02 20:23:58 +0000
+++ doc/source/index.rst	2012-10-24 18:50:26 +0000
@@ -70,6 +70,7 @@
    faq
    release-notes
    glossary
+   xtrabackup-files
    trademark-policy
 
 Indices and tables
 
=== modified file 'doc/source/innobackupex/creating_a_backup_ibk.rst'
--- doc/source/innobackupex/creating_a_backup_ibk.rst	2012-04-21 07:12:28 +0000
+++ doc/source/innobackupex/creating_a_backup_ibk.rst	2012-10-24 18:50:26 +0000
@@ -23,38 +23,7 @@
 
 |innobackupex| called |xtrabackup| binary to backup all the data of |InnoDB| tables (see :doc:`../xtrabackup_bin/creating_a_backup` for details on this process) and copied all the table definitions in the database (:term:`.frm` files), data and files related to |MyISAM|, :term:`MERGE <.MRG>` (reference to other tables), :term:`CSV <.CSV>` and :term:`ARCHIVE <.ARM>` tables, along with :term:`triggers <.TRG>` and :term:`database configuration information <.opt>` to a time stamped directory created in the provided path. 
 
-It will also create the following files for convenience on the created directory:
-
-  * Information related to the backup and the server
-
-    * :file:`xtrabackup_checkpoints`
-       The type of the backup (e.g. full or incremental), its state (e.g. prepared) and the |LSN| range contained in it. This information is used for incremental backups.
-
-    * :file:`xtrabackup_binlog_info`
-       The binary log file used by the server and its position at the moment of the backup. Result of the :command:`SHOW MASTER STATUS`.
-
-    * :file:`xtrabackup_binlog_pos_innodb`
-       The binary log file and its current position for |InnoDB| or |XtraDB| tables.
-
-    * :file:`xtrabackup_binary`
-       The |xtrabackup| binary used in the process.
-
-    * :file:`backup-my.cnf`
-       This file contains information to start the mini instance of InnoDB during the  :option:`--apply-log`. This is NOT a backup of original :file:`my.cnf`.
-    
-    * :file:`xtrabackup_logfile` 
-       Contains data needed for running the: :option:`--apply-log`. The bigger this file is the :option:`--apply-log` process will take longer to finish. 
-
-  * Information related to the replication environment (if using the :option:`--slave-info` option):
-
-    * :file:`xtrabackup_slave_info`
-       The ``CHANGE MASTER`` statement needed for setting up a slave.
-
-  * The output of :program:`mysqld` during the backup process:
-
-    * :file:`mysql-stderr`
-
-    * :file:`mysql-stdout`
+It will also create the :ref:`following files <xtrabackup_files>` for convenience on the created directory.
 
 Other options to consider
 =========================
 
=== added file 'doc/source/xtrabackup-files.rst'
--- doc/source/xtrabackup-files.rst	1970-01-01 00:00:00 +0000
+++ doc/source/xtrabackup-files.rst	2012-10-24 18:50:26 +0000
@@ -0,0 +1,51 @@
+.. _xtrabackup_files :
+
+=====================================
+Index of files created by XtraBackup
+=====================================
+
+* Information related to the backup and the server
+
+    * :file:`backup-my.cnf`
+       This file contains information to start the mini instance of InnoDB during the :option:`--apply-log`. This is **NOT** a backup of original :file:`my.cnf`.
+
+    * :file:`xtrabackup_checkpoints`
+       The type of the backup (e.g. full or incremental), its state (e.g. prepared) and the |LSN| range contained in it. This information is used for incremental backups.
+       Example of the :file:`xtrabackup_checkpoints` after taking a full backup: :: 
+        
+        backup_type = full-backuped
+        from_lsn = 0
+        to_lsn = 15188961605
+        last_lsn = 15188961605
+
+       Example of the :file:`xtrabackup_checkpoints` after taking an incremental backup: :: 
+      
+        backup_type = incremental
+        from_lsn = 15188961605
+        to_lsn = 15189350111
+        last_lsn = 15189350111
+
+    * :file:`xtrabackup_binlog_info`
+       The binary log file used by the server and its position at the moment of the backup. Result of the :command:`SHOW MASTER STATUS`.
+
+    * :file:`xtrabackup_binlog_pos_innodb`
+       The binary log file and its current position for |InnoDB| or |XtraDB| tables.
+
+    * :file:`xtrabackup_binary`
+       The |xtrabackup| binary used in the process.
+    
+    * :file:`xtrabackup_logfile` 
+       Contains data needed for running the: :option:`--apply-log`. The bigger this file is the :option:`--apply-log` process will take longer to finish. 
+
+    * :file:`<table_name>.delta.meta`
+       This file is going to be created when performing the incremental backup. It contains the per-table delta metadata: page size, size of compressed page (if the value is 0 it means the tablespace isn't compressed) and space id. Example of this file could looks like this: :: 
+
+        page_size = 16384
+        zip_size = 0
+        space_id = 0
+
+* Information related to the replication environment (if using the :option:`--slave-info` option):
+
+    * :file:`xtrabackup_slave_info`
+       The ``CHANGE MASTER`` statement needed for setting up a slave.
+
 
=== modified file 'innobackupex'
--- innobackupex	2012-10-16 15:05:23 +0000
+++ innobackupex	2012-10-24 18:50:26 +0000
@@ -262,7 +262,7 @@
 				my $reason = `cat $mysql_stderr`;
 				$mysql_pid = '';
 				# Failed to connect to MySQL
-				die "Failed to connect to MySQL server to detect version.\nYou must set xtrabackup version to use with --ibbackup option.\nPossible values are xtrabackup_51 (for MySQL 5.0 and 5.1) or xtrabackup (for MySQL 5.1 with InnoDB plugin or Percona Server)\n";
+				die "Failed to connect to MySQL server to detect version.\nYou must set xtrabackup version to use with --ibbackup option.\nPossible values are xtrabackup_51 (for MySQL 5.0 and 5.1), xtrabackup_55 (for MySQL 5.5) or xtrabackup (for MySQL 5.1 with InnoDB plugin or Percona Server)\n";
 				}
 			else{
 				mysql_close();