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

[Hrvoje Matijakovic]

[Alexey Kopytov (akopytov)]

Looks good, except that the request in bug #924313 was that we make it clear from our documentation that we don't currently support streaming incremental backups. That is, --incremental, --incremental-basedir and --incremental-lsn are ignored when --stream is specified on the innobackupex command line.

I suggest we mention that in the corresponding options descriptions in http://www.percona.com/doc/percona-xtrabackup/innobackupex/innobackupex_option_reference.html and in http://www.percona.com/doc/percona-xtrabackup/innobackupex/streaming_backups_innobackupex.html

Please also not that we are going to fix this in 1.9.1. And that's the first case when the manual will get out of sync with 1.6. I'm not sure what to do about that. We can either create a separate 1.6 manual, or just ignore it and say that the online XtraBackup docs describe only 2.0.

review: Needs Fixing

[Stewart Smith (stewart)]

On Mon, 13 Feb 2012 15:32:02 -0000, Alexey Kopytov <email address hidden> wrote:
> Please also not that we are going to fix this in 1.9.1. And that's the
> first case when the manual will get out of sync with 1.6. I'm not sure
> what to do about that. We can either create a separate 1.6 manual, or
> just ignore it and say that the online XtraBackup docs describe only
> 2.0.

This is a good question.... and one that (as you may have noticed) I've
rather successfully delayed :)

My current thought is that we note which parts are applicable only to
2.0 or 1.6 and with the major release following 2.0 we split it off.

--
Stewart Smith

[Alexey Kopytov (akopytov)]

review: Approve

=== modified file 'doc/source/conf.py'
--- doc/source/conf.py	2012-02-08 15:08:50 +0000
+++ doc/source/conf.py	2012-02-14 08:36:17 +0000
@@ -53,7 +53,7 @@
 # The short X.Y version.
 version = '1.6'
 # The full version, including alpha/beta/rc tags.
-release = '2'
+release = '5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
=== modified file 'doc/source/innobackupex/how_innobackupex_works.rst'
--- doc/source/innobackupex/how_innobackupex_works.rst	2011-10-24 18:37:06 +0000
+++ doc/source/innobackupex/how_innobackupex_works.rst	2012-02-14 08:36:17 +0000
@@ -53,7 +53,7 @@
 :file:`mysql-stdout`
   containing the ``STDOUT`` of the server.
 
-If the :option:`--remote-host` was set, |innobackupex| will test the connection to the host via :command:`ssh` and create the backup directories. Then the same process will be applied but the log will be written to a temporary file and will be copied via :command:`scp` with the options set by :option:`--options-scp` (``-Cp -c arcfour`` by default).
+If the :option:`--remote-host` was set, |innobackupex| will test the connection to the host via :command:`ssh` and create the backup directories. Then the same process will be applied but the log will be written to a temporary file and will be copied via :command:`scp` with the options set by :option:`--scpopt` (``-Cp -c arcfour`` by default).
 
 After each copy the files will be deleted. The same rationale is for the :option:`--stream` mode.
 
 
=== modified file 'doc/source/innobackupex/innobackupex_option_reference.rst'
--- doc/source/innobackupex/innobackupex_option_reference.rst	2012-02-02 20:24:24 +0000
+++ doc/source/innobackupex/innobackupex_option_reference.rst	2012-02-14 08:36:17 +0000
@@ -109,7 +109,7 @@
 
 .. option:: --incremental-lsn
 
-   This option accepts a string argument that specifies the log sequence number (:term:`LSN`) to use for the incremental backup. It is used with the :option:`--incremental` option. It is used instead of specifying :option:`--incremental-basedir`. For databases created by *MySQL* and *Percona Server* 5.0-series versions, specify the as two 32-bit integers in high:low format. For databases created in 5.1 and later, specify the LSN as a single 64-bit integer.
+   This option accepts a string argument that specifies the log sequence number (:term:`LSN`) to use for the incremental backup. It is used with the :option:`--incremental` option. It is used instead of specifying :option:`--incremental-basedir`. For databases created by *MySQL* and *Percona Server* 5.0-series versions, specify the as two 32-bit integers in high:low format. For databases created in 5.1 and later, specify the LSN as a single 64-bit integer. 
 
 .. option:: --extra-lsndir
 
@@ -121,7 +121,7 @@
 
 .. option:: --stream
 
-   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, the only supported format is :command:`tar`. Uses :doc:`tar4ibd <../tar4ibd/tar4ibd_binary>`, which is available in *XtraBackup* distributions. If you specify a path after this option, it will be interpreted as the value of :option:`tmpdir`.
+   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, the only supported format is :command:`tar`. Uses :doc:`tar4ibd <../tar4ibd/tar4ibd_binary>`, which is available in *XtraBackup* distributions. If you specify a path after this option, it will be interpreted as the value of :option:`tmpdir`.  If both :option:`--stream` and :option:`--incremental` are passed to innobackupex, the incremental parameters are ignored and a full backup is created.
 
 .. option:: --tmpdir
 
@@ -135,7 +135,7 @@
 
    This option forces the use of :command:`tar` when creating a streamed backup, rather than :program:`tar4ibd`, which is the default.
 
-.. option:: --scp-opt = '-Cp -c arcfour'
+.. option:: --scpopt = '-Cp -c arcfour'
 
    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``.
 
 
=== modified file 'doc/source/innobackupex/streaming_backups_innobackupex.rst'
--- doc/source/innobackupex/streaming_backups_innobackupex.rst	2011-09-28 01:11:16 +0000
+++ doc/source/innobackupex/streaming_backups_innobackupex.rst	2012-02-14 08:36:17 +0000
@@ -6,6 +6,8 @@
 
 This allows to pipe the stream to other programs, providing great flexibility to the output of it. For example, compression is achieved by piping the output to a compression utility.
 
+.. warning:: If both --stream and --incremental are passed to innobackupex, the incremental parameters are ignored and a full backup is created.
+
 To use this feature, you must use the :option:`--stream`, providing the format of the stream (only ``tar`` is supported at this moment) and where should the store the temporary files::
 
  $ innobackupex --stream=tar /tmp
 
=== modified file 'src/xtrabackup.c'
--- src/xtrabackup.c	2012-02-10 20:05:56 +0000
+++ src/xtrabackup.c	2012-02-14 08:36:17 +0000
@@ -1036,7 +1036,7 @@
   {"extra-lsndir", OPT_XTRA_EXTRA_LSNDIR, "(for --backup): save an extra copy of the xtrabackup_checkpoints file in this directory.",
    (G_PTR*) &xtrabackup_extra_lsndir, (G_PTR*) &xtrabackup_extra_lsndir,
    0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
-  {"incremental-lsn", OPT_XTRA_INCREMENTAL, "(for --backup): copy only .ibd pages newer than specified LSN 'high:low'. ##ATTENTION##: checkpoint lsn must be used. anyone can detect your mistake. be carefully!",
+  {"incremental-lsn", OPT_XTRA_INCREMENTAL, "(for --backup): copy only .ibd pages newer than specified LSN 'high:low'. ##ATTENTION##: If a wrong LSN value is specified, it is impossible to diagnose this, causing the backup to be unusable. Be careful!",
    (G_PTR*) &xtrabackup_incremental, (G_PTR*) &xtrabackup_incremental,
    0, GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
   {"incremental-basedir", OPT_XTRA_INCREMENTAL_BASEDIR, "(for --backup): copy only .ibd pages newer than backup at specified directory.",