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

[Hrvoje Matijakovic]

[Alexey Kopytov (akopytov)]

review: Approve

=== modified file 'doc/source/innobackupex/innobackupex_option_reference.rst'
--- doc/source/innobackupex/innobackupex_option_reference.rst	2013-04-29 11:55:07 +0000
+++ doc/source/innobackupex/innobackupex_option_reference.rst	2013-04-30 07:38:25 +0000
@@ -40,7 +40,7 @@
 
 .. option:: --defaults-group=GROUP-NAME
 
-   This option accepts a string argument that specifies the group which should be read from the configuration file. This is needed if you use mysqld_multi.
+   This option accepts a string argument that specifies the group which should be read from the configuration file. This is needed if you use mysqld_multi. This can also be used to indicate groups other than mysqld and xtrabackup.
 
 .. option:: --export
 
@@ -139,10 +139,6 @@
 
    This option accepts a string argument that specifies the command line options to pass to :command:`scp` when the option :option:`--remost-host` is specified. If the option is not specified, the default options are ``-Cp -c arcfour``.
 
-.. option:: --sshopt = SSH-OPTIONS
-
-   This option accepts a string argument that specifies the command line options to pass to :command:`ssh` when the option :option:`--remost-host` is specified.
-
 .. option:: --slave-info
 
    This option is useful when backing up a replication slave server. It prints the binary log position and name of the master server. It also writes this information to the :file:`xtrabackup_slave_info` file as a ``CHANGE MASTER`` command. A new slave for this master can be set up by starting a slave server on this backup and issuing a ``CHANGE MASTER`` command with the binary log position saved in the :file:`xtrabackup_slave_info` file.
@@ -151,6 +147,10 @@
 
    This option accepts a string argument that specifies the socket to use when connecting to the local database server with a UNIX domain socket. It is passed to the mysql child process without alteration. See :command:`mysql --help` for details.
 
+.. option:: --sshopt = SSH-OPTIONS
+
+   This option accepts a string argument that specifies the command line options to pass to :command:`ssh` when the option :option:`--remost-host` is specified.
+
 .. option:: --stream=STREAMNAME
 
    This option accepts a string argument that specifies the format in which to do the streamed backup. The backup will be done to ``STDOUT`` in the specified format. Currently, supported formats are `tar` and `xbstream`. Uses :doc:`xbstream <../xbstream/xbstream>`, which is available in *XtraBackup* distributions. If you specify a path after this option, it will be interpreted as the value of :option:`tmpdir`
@@ -165,7 +165,7 @@
 
 .. option:: --tmpdir=DIRECTORY
 
-   This option accepts a string argument that specifies the location where a temporary file will be stored. It may be used when :option:`--remote-host` or :option:`--stream` is specified. For these options, the transaction log will first be stored to a temporary file, before streaming or copying to a remote host. This option specifies the location where that temporary file will be stored. If the option is not specifed, the default is to use the value of ``tmpdir`` read from the server configuration.
+   This option accepts a string argument that specifies the location where a temporary file will be stored. It may be used when :option:`--remote-host` or :option:`--stream` is specified. For these options, the transaction log will first be stored to a temporary file, before streaming or copying to a remote host. This option specifies the location where that temporary file will be stored. If the option is not specified, the default is to use the value of ``tmpdir`` read from the server configuration. innobackupex is passing the tmpdir value specified in my.cnf as the --target-dir option to the xtrabackup binary. Both [mysqld] and [xtrabackup] groups are read from my.cnf. If there is tmpdir in both, then the value being used depends on the order of those group in my.cnf.
 
 .. option:: --use-memory
 

=== modified file 'doc/source/installation/apt_repo.rst'
--- doc/source/installation/apt_repo.rst	2012-11-29 16:23:29 +0000
+++ doc/source/installation/apt_repo.rst	2013-04-30 07:38:25 +0000
@@ -4,11 +4,7 @@
 
 *Debian* and *Ubuntu* packages from *Percona* are signed with a key. Before using the repository, you should add the key to :program:`apt`. To do that, run the following commands: ::
 
-  $ gpg --keyserver  hkp://keys.gnupg.net --recv-keys 1C4CBDCDCD2EFD2A
-  ... [some output removed] ...
-  gpg:               imported: 1
-  
-  $ gpg -a --export CD2EFD2A | sudo apt-key add -
+  $ apt-key adv --keyserver keys.gnupg.net --recv-keys 1C4CBDCDCD2EFD2A
 
 Add this to :file:`/etc/apt/sources.list`, replacing ``VERSION`` with the name of your distribution: ::
 

=== modified file 'doc/source/installation/compiling_xtrabackup.rst'
--- doc/source/installation/compiling_xtrabackup.rst	2013-04-29 09:29:00 +0000
+++ doc/source/installation/compiling_xtrabackup.rst	2013-04-30 07:38:25 +0000
@@ -47,10 +47,26 @@
 
 Note that the script must be executed from the base directory of |Xtrabackup| sources, and that directory must contain the packages with the source code of the codebase selected. This may appear cumbersome, but if the variable ``AUTO_LOAD="yes"`` is set, the :command:`build.sh` script will download all the source code needed for the build.
 
+.. note:: 
+  The exact versions expected by build.sh script should be used. Changing the version info in build.sh to have it build against a different server version is not supported.
+
 At the base directory of the downloaded source code, if you execute ::
 
   $ AUTO_DOWNLOAD="yes" ./utils/build.sh xtradb
 
-and you go for a coffee, at your return |XtraBackup| will be ready to be used. The |xtrabackup| binary will be located in the ``percona-xtrabackup/src`` subdirectory.
+In case you're not able to use ``AUTO_DOWNLOAD="yes"`` option, sources can be downloaded manually for each release:
+
+  ================== =========  ===========================================================================
+  Value              Alias      Source tarball download link
+  ================== =========  ===========================================================================
+  innodb51_builtin   5.1        http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.1.59.tar.gz
+  innodb51           plugin     http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.1.59.tar.gz
+  innodb55           5.5        http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.5.17.tar.gz
+  xtradb51           xtradb     http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.1.59.tar.gz
+  xtradb55           xtradb55   http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.5.16.tar.gz
+  innodb56           5.6        http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.6.10.tar.gz
+  ================== =========  ===========================================================================
+
+After the build has finished |XtraBackup| will be ready to be used. The |xtrabackup| binary will be located in the ``percona-xtrabackup/src`` subdirectory.
 
 After this you'll need to copy |innobackupex| (in the root folder used to retrieve |XtraBackup|) and the corresponding xtrabackup binary (in the src folder) to some directory listed in the PATH environment variable, e.g. ``/usr/bin``.

=== modified file 'doc/source/xtrabackup_bin/preparing_the_backup.rst'
--- doc/source/xtrabackup_bin/preparing_the_backup.rst	2012-02-02 20:16:23 +0000
+++ doc/source/xtrabackup_bin/preparing_the_backup.rst	2013-04-30 07:38:25 +0000
@@ -4,6 +4,10 @@
 
 After you make a backup with :option:`--backup`, the next step is to prepare it. The data files are not point-in-time consistent until they've been prepared, because they were copied at different times as the program ran, and they might have been changed while this was happening. If you try to start InnoDB with these data files, it will detect corruption and crash itself to prevent you from running on damaged data. The :option:`--prepare` step makes the files perfectly consistent at a single instant in time, so you can run |InnoDB| on them.
 
+.. note:: 
+
+  For prepare "innobackupex --apply-log" should be used which will read |InnoDB| configuration from backup-my.cnf automatically, or --defaults-file=backup-my.cnf should be passed to the xtrabackup binary if it is used for preparing the backup. Otherwise it could lead to incorrect restore because xtrabackup could use wrong configuration options. 
+
 You can run the prepare operation on any machine; it does not need to be on the originating server or the server to which you intend to restore. You can copy the backup to a utility server and prepare it there, for example. It is important, however, that you use the same version of the xtrabackup binary that you used to create the backup to do the prepare.
 
 During the prepare operation, |xtrabackup| boots up a kind of modified InnoDB that's embedded inside it (the libraries it was linked against). The modifications are necessary to disable InnoDB's standard safety checks, such as complaining that the log file isn't the right size, which aren't appropriate for working with backups. These modifications are only for the xtrabackup binary; you don't need a modified |InnoDB| to use |xtrabackup| for your backups.

=== modified file 'doc/source/xtrabackup_bin/xbk_option_reference.rst'
--- doc/source/xtrabackup_bin/xbk_option_reference.rst	2013-04-29 11:55:07 +0000
+++ doc/source/xtrabackup_bin/xbk_option_reference.rst	2013-04-30 07:38:25 +0000
@@ -9,22 +9,6 @@
 Options
 =======
 
-.. option:: --print-defaults
-
-   Print the program argument list and exit. Must be given as the first option on the command-line.
-
-.. option:: --no-defaults
-
-   Don't read default options from any option file. Must be given as the first option on the command-line.
-
-.. option:: --defaults-file=#
-
-   Only read default options from the given file. Must be given as the first option on the command-line. Must be a real file; it cannot be a symbolic link.
-
-.. option:: --defaults-extra-file=#
-
-   Read this file after the global files are read. Must be given as the first option on the command-line.
-
 .. option:: --apply-log-only
 
    This option causes only the redo stage to be performed when preparing a backup. It is very important for incremental backups.
@@ -49,6 +33,18 @@
 
    The source directory for the backup. This should be the same as the datadir for your MySQL server, so it should be read from :file:`my.cnf` if that exists; otherwise you must specify it on the command line.
 
+.. option:: --defaults-extra-file=#
+
+   Read this file after the global files are read. Must be given as the first option on the command-line.
+
+.. option:: --defaults-file=#
+
+   Only read default options from the given file. Must be given as the first option on the command-line. Must be a real file; it cannot be a symbolic link.
+
+.. option:: --defaults-group
+
+   This option is to set the group which should be read from the configuration file. This is used by innobackupex if you use the `--defaults-group` option. It is needed for mysqld_multi deployments.
+
 .. option:: --export
 
    Create files necessary for exporting tables. See :doc:`Exporting and Importing Tables <exporting_importing_tables>`.
@@ -101,10 +97,6 @@
     --innodb-read-io-threads
     --innodb-write-io-threads
 
-.. option:: --defaults-group
-
-   This option is to set the group which should be read from the configuration file. This is used by innobackupex if you use the `--defaults-group` option. It is needed for mysqld_multi deployments.
-
 .. option:: --log-copy-interval
 
    This option specifies time interval between checks done by log copying thread in milliseconds (default is 1 second).
@@ -113,14 +105,22 @@
 
    Makes xtrabackup not copy data files, and output the contents of the InnoDB log files to STDOUT until the :option:`--suspend-at-end` file is deleted. This option enables :option:`--suspend-at-end` automatically.
 
-.. option:: --stream=name 
-
-   Stream all backup files to the standard output in the specified format. Currently supported formats are 'xbstream' and 'tar'.
+.. option:: --no-defaults
+
+   Don't read default options from any option file. Must be given as the first option on the command-line.
+
+.. option:: --parallel=#
+
+   This option specifies the number of threads to use to copy multiple data files concurrently when creating a backup. The default value is 1 (i.e., no concurrent transfer).
 
 .. option:: --prepare
 
    Makes :program:`xtrabackup` perform recovery on a backup created with :option:`--backup`, so that it is ready to use. See :doc:`preparing a backup <preparing_the_backup>`.
 
+.. option:: --print-defaults
+
+   Print the program argument list and exit. Must be given as the first option on the command-line.
+
 .. option:: --print-param
 
    Makes :program:`xtrabackup` print out parameters that can be used for copying the data files back to their original locations to restore them. See :ref:`scripting-xtrabackup`.
@@ -129,18 +129,22 @@
 
    Causes :program:`xtrabackup` to scan the specified data files and print out index statistics.
 
+.. option:: --stream=name 
+
+   Stream all backup files to the standard output in the specified format. Currently supported formats are 'xbstream' and 'tar'.
+
 .. option:: --suspend-at-end
 
    Causes :program:`xtrabackup` to create a file called :file:`xtrabackup_suspended` in the :option:`--target-dir`. Instead of exiting after copying data files, :program:`xtrabackup` continues to copy the log file, and waits until the :file:`xtrabackup_suspended` file is deleted. This enables xtrabackup and other programs to coordinate their work. See :ref:`scripting-xtrabackup`.
 
+.. option:: --tables=name
+
+   A regular expression against which the full tablename, in ``databasename.tablename`` format, is matched. If the name matches, the table is backed up. See :doc:`partial backups <partial_backups>`.
+
 .. option:: --tables-file=name
 
    A file containing one table name per line, in databasename.tablename format. The backup will be limited to the specified tables. See :ref:`scripting-xtrabackup`.
 
-.. option:: --tables=name
-
-   A regular expression against which the full tablename, in ``databasename.tablename`` format, is matched. If the name matches, the table is backed up. See :doc:`partial backups <partial_backups>`.
-
 .. option:: --target-dir=name
 
    This option specifies the destination directory for the backup. If the directory does not exist, :program:`xtrabackup` creates it. If the directory does exist and is empty, :program:`xtrabackup` will succeed. :program:`xtrabackup` will not overwrite existing files, however; it will fail with operating system error 17, ``file exists``.
@@ -159,10 +163,6 @@
 
    This option affects how much memory is allocated for preparing a backup with :option:`--prepare`, or analyzing statistics with :option:`--stats`. Its purpose is similar to :term:`innodb_buffer_pool_size`. It does not do the same thing as the similarly named option in Oracle's InnoDB Hot Backup tool. The default value is 100MB, and if you have enough available memory, 1GB to 2GB is a good recommended value.
 
-.. option:: --parallel=#
-
-   This option specifies the number of threads to use to copy multiple data files concurrently when creating a backup. The default value is 1 (i.e., no concurrent transfer).
-
 .. option:: --version
 
    This option prints |xtrabackup| version and exits.

=== modified file 'utils/build.sh'
--- utils/build.sh	2013-04-16 11:06:01 +0000
+++ utils/build.sh	2013-04-30 07:38:25 +0000
@@ -77,7 +77,7 @@
     echo "where CODEBASE can be one of the following values or aliases:"
     echo "  innodb50         | 5.0                   build against innodb 5.1 builtin, but should be compatible with MySQL 5.0"
     echo "  innodb51_builtin | 5.1                   build against built-in InnoDB in MySQL 5.1"
-    echo "  innodb51         | plugin                build agsinst InnoDB plugin in MySQL 5.1"
+    echo "  innodb51         | plugin                build against InnoDB plugin in MySQL 5.1"
     echo "  innodb55         | 5.5                   build against InnoDB in MySQL 5.5"
     echo "  innodb56         | 5.6,xtradb56,         build against InnoDB in MySQL 5.6"
     echo "                   | mariadb100"