Merge lp:~hrvojem/percona-xtrabackup/doc-69-2.2 into lp:percona-xtrabackup/2.2

Proposed by Hrvoje Matijakovic
Status: Merged
Approved by: Alexey Kopytov
Approved revision: no longer in the source branch.
Merged at revision: 4958
Proposed branch: lp:~hrvojem/percona-xtrabackup/doc-69-2.2
Merge into: lp:percona-xtrabackup/2.2
Diff against target: 274 lines (+98/-59)
9 files modified
.bzrignore (+2/-0)
storage/innobase/xtrabackup/doc/Makefile (+1/-1)
storage/innobase/xtrabackup/doc/source/conf.py (+5/-5)
storage/innobase/xtrabackup/doc/source/index.rst (+5/-0)
storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst (+2/-0)
storage/innobase/xtrabackup/doc/source/installation/compiling_xtrabackup.rst (+34/-47)
storage/innobase/xtrabackup/doc/source/installation/yum_repo.rst (+12/-6)
storage/innobase/xtrabackup/doc/source/release-notes.rst (+8/-0)
storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst (+29/-0)
To merge this branch: bzr merge lp:~hrvojem/percona-xtrabackup/doc-69-2.2
Reviewer Review Type Date Requested Status
Alexey Kopytov (community) Approve
Review via email: mp+212688@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Alexey Kopytov (akopytov) wrote :

Looks good except the following:

+ |Percona XtraBackup| has removed the ``build.sh`` and ``AUTO_DOWNLOAD`` scripts and it's now :ref:`built with CMake <compiling_xtrabackup>`.
270 +

AUTO_DOWNLOAD is an environment variable used by build.sh. I suggest we just mention build.sh removal.

review: Needs Fixing
Revision history for this message
Alexey Kopytov (akopytov) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file '.bzrignore'
2--- .bzrignore 2013-11-26 10:44:44 +0000
3+++ .bzrignore 2014-03-26 07:40:50 +0000
4@@ -3152,3 +3152,5 @@
5 ./storage/innobase/xtrabackup/src/CMakeCache.txt
6 ./storage/innobase/xtrabackup/src/xtrabackup_version.h
7 ./storage/innobase/xtrabackup/CMakeCache.txt
8+./storage/innobase/xtrabackup/doc/build/
9+./storage/innobase/xtrabackup/doc/source/percona-theme/
10
11=== modified file 'storage/innobase/xtrabackup/doc/Makefile'
12--- storage/innobase/xtrabackup/doc/Makefile 2012-11-22 09:55:05 +0000
13+++ storage/innobase/xtrabackup/doc/Makefile 2014-03-26 07:40:50 +0000
14@@ -38,7 +38,7 @@
15
16 html:
17 @echo "Downloading percona-theme ..."
18- @wget -O percona-theme.tar.gz http://percona.com/docs/theme/percona-xtrabackup/2.1
19+ @wget -O percona-theme.tar.gz http://percona.com/docs/theme/percona-xtrabackup/2.2
20 @echo "Extracting theme."
21 @tar -zxf percona-theme.tar.gz
22 @rm -rf source/percona-theme
23
24=== modified file 'storage/innobase/xtrabackup/doc/source/conf.py'
25--- storage/innobase/xtrabackup/doc/source/conf.py 2014-03-04 08:31:24 +0000
26+++ storage/innobase/xtrabackup/doc/source/conf.py 2014-03-26 07:40:50 +0000
27@@ -152,10 +152,10 @@
28
29 # The name for this set of Sphinx documents. If None, it defaults to
30 # "<project> v<release> documentation".
31-html_title = 'Percona XtraBackup Documentation'
32+html_title = 'Percona XtraBackup 2.2 Documentation'
33
34 # A shorter title for the navigation bar. Default is the same as html_title.
35-html_short_title = 'Percona XtraBackup Docs'
36+html_short_title = 'Percona XtraBackup 2.2 Documentation'
37
38 # The name of an image file (relative to this directory) to place at the top
39 # of the sidebar.
40@@ -213,7 +213,7 @@
41 #html_file_suffix = None
42
43 # Output file base name for HTML help builder.
44-htmlhelp_basename = 'PerconaXtraBackupDoc'
45+htmlhelp_basename = 'PerconaXtraBackupDocumentation'
46
47
48 # -- Options for LaTeX output --------------------------------------------------
49@@ -227,7 +227,7 @@
50 # Grouping the document tree into LaTeX files. List of tuples
51 # (source start file, target name, title, author, documentclass [howto/manual]).
52 latex_documents = [
53- ('index', 'PerconaXtraBackup-2.2.tex', u'Percona XtraBackup Documentation',
54+ ('index', 'PerconaXtraBackup-2.2.tex', u'Percona XtraBackup 2.2 Documentation',
55 u'Percona LLC and/or its affiliates', 'manual'),
56 ]
57
58@@ -260,7 +260,7 @@
59 # One entry per manual page. List of tuples
60 # (source start file, name, description, authors, manual section).
61 man_pages = [
62- ('xtrabackup_bin/xtrabackup_binary', 'xtrabackup', u'Percona XtraBackup Documentation',
63+ ('xtrabackup_bin/xtrabackup_binary', 'xtrabackup', u'Percona XtraBackup 2.2 Documentation',
64 [u'Percona LLC and/or its affiliates'], 1),
65 ('innobackupex/innobackupex_script', 'innobackupex', u'innobackupex Documentation',
66 [u'Percona LLC and/or its affiliates'], 1),
67
68=== modified file 'storage/innobase/xtrabackup/doc/source/index.rst'
69--- storage/innobase/xtrabackup/doc/source/index.rst 2013-11-15 12:42:15 +0000
70+++ storage/innobase/xtrabackup/doc/source/index.rst 2014-03-26 07:40:50 +0000
71@@ -15,6 +15,11 @@
72
73 |Percona XtraBackup| is a combination of the |xtrabackup| *C* program, and the |innobackupex| *Perl* script. The |xtrabackup| program copies and manipulates |InnoDB| and |XtraDB| data files, and the *Perl* script enables enhanced functionality, such as interacting with a running |MySQL| server and backing up |MyISAM| tables.
74
75+.. warning::
76+
77+ This is an **ALPHA** quality release and it is not intended for production.
78+
79+
80 Introduction
81 ============
82
83
84=== modified file 'storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst'
85--- storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst 2013-11-21 10:08:38 +0000
86+++ storage/innobase/xtrabackup/doc/source/installation/apt_repo.rst 2014-03-26 07:40:50 +0000
87@@ -39,6 +39,8 @@
88 * 13.04 (raring)
89 * 13.10 (saucy)
90
91+.. _debian_experimental:
92+
93 Experimental Repository
94 =======================
95
96
97=== modified file 'storage/innobase/xtrabackup/doc/source/installation/compiling_xtrabackup.rst'
98--- storage/innobase/xtrabackup/doc/source/installation/compiling_xtrabackup.rst 2014-01-21 08:33:35 +0000
99+++ storage/innobase/xtrabackup/doc/source/installation/compiling_xtrabackup.rst 2014-03-26 07:40:50 +0000
100@@ -1,10 +1,12 @@
101+.. _compiling_xtrabackup:
102+
103 ===========================================
104 Compiling and Installing from Source Code
105 ===========================================
106
107 The source code is available from the *Launchpad* project `here <https://launchpad.net/percona-xtrabackup>`_. The easiest way to get the code is with :command:`bzr branch` of the desired release, such as the following: ::
108
109- bzr branch lp:percona-xtrabackup/2.1
110+ bzr branch lp:percona-xtrabackup/2.2
111
112 You should then have a directory named after the release you branched, such as ``percona-xtrabackup``.
113
114@@ -19,52 +21,37 @@
115
116 In Debian-based distributions, you need to: ::
117
118- $ apt-get install debhelper autotools-dev libaio-dev wget automake \
119- libtool bison libncurses-dev libz-dev cmake bzr libgcrypt11-dev
120+ $ apt-get install build-essential flex bison automake autoconf bzr \
121+ libtool cmake libaio-dev mysql-client libncurses-dev zlib1g-dev \
122+ libgcrypt11-dev
123+
124
125 In ``RPM``-based distributions, you need to: ::
126-
127+
128 $ yum install cmake gcc gcc-c++ libaio libaio-devel automake autoconf bzr \
129- bison libtool ncurses-devel zlib-devel libgcrypt-devel
130-
131-Compiling with :command:`build.sh`
132-----------------------------------
133-
134-Once you have all dependencies met, the compilation is straight-forward with the bundled :command:`build.sh` script in the :file:`utils/` directory of the distribution.
135-
136-The script needs the codebase for which the building is targeted, you must provide it with one of the following values or aliases:
137-
138- ================== ========= ============================================
139- Value Alias Server
140- ================== ========= ============================================
141- innodb51 plugin build against InnoDB plugin in MySQL 5.1
142- innodb55 5.5 build against InnoDB in MySQL 5.5
143- xtradb51 xtradb build against Percona Server with XtraDB 5.1
144- xtradb55 xtradb55 build against Percona Server with XtraDB 5.5
145- innodb56 5.6 build against InnoDB in MySQL 5.6
146- ================== ========= ============================================
147-
148-Note that the script must be executed from the base directory of |Percona 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.
149-
150-.. note::
151- 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.
152-
153-At the base directory of the downloaded source code, if you execute ::
154-
155- $ AUTO_DOWNLOAD="yes" ./utils/build.sh xtradb
156-
157-In case you're not able to use ``AUTO_DOWNLOAD="yes"`` option, sources can be downloaded manually for each release:
158-
159- ================== ========= ===========================================================================
160- Value Alias Source tarball download link
161- ================== ========= ===========================================================================
162- innodb51 plugin http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.1.59.tar.gz
163- innodb55 5.5 http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.5.17.tar.gz
164- xtradb51 xtradb http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.1.59.tar.gz
165- xtradb55 xtradb55 http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.5.16.tar.gz
166- innodb56 5.6 http://s3.amazonaws.com/percona.com/downloads/community/mysql-5.6.10.tar.gz
167- ================== ========= ===========================================================================
168-
169-After the build has finished |Percona XtraBackup| will be ready to be used. The |xtrabackup| binary will be located in the ``percona-xtrabackup/src`` subdirectory.
170-
171-After this you’ll need to copy |innobackupex| (in the root folder used to retrieve |Percona XtraBackup|) and the corresponding xtrabackup binary (in the src folder) to some directory listed in the PATH environment variable, e.g. ``/usr/bin``.
172+ bison libtool ncurses5-devel
173+
174+Compiling with CMake
175+--------------------
176+
177+At the base directory of the source code tree, if you execute: ::
178+
179+ $ cmake -DBUILD_CONFIG=xtrabackup_release && make -j4
180+
181+and you go for a coffee, at your return |Percona XtraBackup| will be ready to be used.
182+
183+Installation
184+------------
185+
186+The following command: ::
187+
188+ $ make install
189+
190+will install all |Percona XtraBackup| binaries, the |innobackupex| script and tests to :file:`/usr/local/xtrabackup`. You can override this either with: ::
191+
192+ make DESTDIR=... install
193+
194+or by changing the installation layout with: ::
195+
196+ cmake -DINSTALL_LAYOUT=...
197+
198
199=== modified file 'storage/innobase/xtrabackup/doc/source/installation/yum_repo.rst'
200--- storage/innobase/xtrabackup/doc/source/installation/yum_repo.rst 2012-02-02 20:12:11 +0000
201+++ storage/innobase/xtrabackup/doc/source/installation/yum_repo.rst 2014-03-26 07:40:50 +0000
202@@ -69,9 +69,15 @@
203 * *CentOS* 6 and *RHEL* 6
204 * *Amazon Linux AMI* (works the same as *CentOS* 5)
205
206-Release Candidate Repository
207-============================
208-
209-To subscribe to the release candidate repository, install the release candidate (RC) *RPM*: ::
210-
211- rpm -Uhv http://www.percona.com/downloads/percona-release/percona-rc-0.0-2.x86_64.rpm
212+.. _yum_testing:
213+
214+Percona `yum` testing repository
215+=====================================
216+
217+Percona offers fresh beta builds from the experimental repository. To subscribe to the experimental repository, install the experimental *RPM*: ::
218+
219+ yum install http://repo.percona.com/testing/centos/6/os/noarch/percona-testing-0.0-1.noarch.rpm
220+
221+.. note::
222+ This repository works for both RHEL/CentOS 5 and RHEL/CentOS 6
223+
224
225=== modified file 'storage/innobase/xtrabackup/doc/source/release-notes.rst'
226--- storage/innobase/xtrabackup/doc/source/release-notes.rst 2013-08-30 09:55:04 +0000
227+++ storage/innobase/xtrabackup/doc/source/release-notes.rst 2014-03-26 07:40:50 +0000
228@@ -40,3 +40,11 @@
229
230 release-notes/2.1/*
231
232+Percona |XtraBackup| 2.2
233+=========================
234+
235+.. toctree::
236+ :maxdepth: 1
237+ :glob:
238+
239+ release-notes/2.2/*
240
241=== added directory 'storage/innobase/xtrabackup/doc/source/release-notes/2.2'
242=== added file 'storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst'
243--- storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst 1970-01-01 00:00:00 +0000
244+++ storage/innobase/xtrabackup/doc/source/release-notes/2.2/2.2.1-alpha1.rst 2014-03-26 07:40:50 +0000
245@@ -0,0 +1,29 @@
246+=======================================
247+ |Percona XtraBackup| 2.2.1-alpha1
248+=======================================
249+
250+Percona is glad to announce the release of |Percona XtraBackup| 2.2.1-alpha1 on March 28th 2014. Downloads are available from our download site `here <http://www.percona.com/downloads/XtraBackup/2.2.1/>`_. This **ALPHA** release, will be available in :ref:`Debian experimental <debian_experimental>` and :ref:`CentOS testing <yum_testing>` repositories.
251+
252+This is an **ALPHA** quality release and it is not intended for production. If you want a high quality, Generally Available release, the current Stable version should be used (currently 2.1.8 in the 2.1 series at the time of writing).
253+
254+This release contains all of the features and bug fixes in :doc:`Percona XtraBackup 2.1.8 </release-notes/2.1/2.1.8>`, plus the following:
255+
256+New features
257+------------
258+
259+ |Percona XtraBackup| has removed the multiple binaries (``xtrabackup_56``, ``xtrabackup_55``, ``xtrabackup``) and now uses single ``xtrabackup`` binary instead for handling backups. Single binary implementation removed the requirement to download server source tarballs and removed different patches which resulted in cleaner code.
260+
261+ |Percona XtraBackup| source layout has been changed to implement the single binary. |Percona XtraBackup| code can now be found in :file:`storage/innobase/xtrabackup`.
262+
263+ |Percona XtraBackup| implemented support for `Backup Locks <http://www.percona.com/doc/percona-server/5.6/management/backup_locks.html#backup-locks>`_.
264+
265+ |Percona XtraBackup| can now store backup history on the server itself in a special table created for that purpose.
266+
267+ ``innobackupex-1.5.1`` symlink has been removed, instead |innobackupex| binary should be used.
268+
269+ |Percona XtraBackup| has removed the ``build.sh`` script and it's now :ref:`built with CMake <compiling_xtrabackup>`.
270+
271+ |Percona XtraBackup| has been rebased on |MySQL| 5.6.16.
272+
273+
274+

Subscribers

People subscribed via source and target branches