Merge lp:~tplavcic/percona-xtrabackup/bug1156209-2.2 into lp:percona-xtrabackup/2.2

[Tomislav Plavcic]

Man pages were added before but they were not build and added into packages/tarball.
Changes were made to our build nodes to support sphinx-build and also made changes in cmake and packages to generate man pages on build and include them into packages.

Some testing is below:

---------------------
XtraBackup 2 .2 test:
---------------------

Debian Squeeze
--------------
Checked that man xtrabackup, man xbstream, man xbcrypt and man innobackupex actually show man pages when package installed.

Content of the package:
vagrant@t-debian6-64:~$ dpkg -c percona-xtrabackup_2.2.7-5061-1.squeeze_amd64.deb |grep man
drwxr-xr-x root/root 0 2015-01-16 08:31 ./usr/share/man/
drwxr-xr-x root/root 0 2015-01-16 08:31 ./usr/share/man/man1/
-rw-r--r-- root/root 20290 2015-01-16 08:31 ./usr/share/man/man1/xtrabackup.1.gz
-rw-r--r-- root/root 816 2015-01-16 08:31 ./usr/share/man/man1/xbcrypt.1.gz
-rw-r--r-- root/root 1229 2015-01-16 08:31 ./usr/share/man/man1/xbstream.1.gz
-rw-r--r-- root/root 24293 2015-01-16 08:31 ./usr/share/man/man1/innobackupex.1.gz

Ubuntu Trusty
-------------
Checked running man ... command on installed package - works fine.

Content of the package:
vagrant@t-ubuntu1404-64:~$ dpkg -c percona-xtrabackup_2.2.7-5061-1.trusty_amd64.deb |grep man
drwxr-xr-x root/root 0 2015-01-16 00:32 ./usr/share/man/
drwxr-xr-x root/root 0 2015-01-16 00:32 ./usr/share/man/man1/
-rw-r--r-- root/root 24488 2015-01-16 00:32 ./usr/share/man/man1/innobackupex.1.gz
-rw-r--r-- root/root 810 2015-01-16 00:32 ./usr/share/man/man1/xbcrypt.1.gz
-rw-r--r-- root/root 20416 2015-01-16 00:32 ./usr/share/man/man1/xtrabackup.1.gz
-rw-r--r-- root/root 1231 2015-01-16 00:32 ./usr/share/man/man1/xbstream.1.gz

Centos5
-------
Checked running man ... command on installed package.

Content of the package:
[vagrant@t-centos5-64 ~]$ rpm -qlp percona-xtrabackup-2.2.7-5061.el5.x86_64.rpm |grep man
/usr/share/man/man1/innobackupex.1.gz
/usr/share/man/man1/xbcrypt.1.gz
/usr/share/man/man1/xbstream.1.gz
/usr/share/man/man1/xtrabackup.1.gz

Centos7
-------
Checked running man ... command on installed package - works fine.

Content of the package:
[vagrant@localhost ~]$ rpm -qlp percona-xtrabackup-2.2.7-5061.el7.x86_64.rpm |grep man
/usr/share/man/man1/innobackupex.1.gz
/usr/share/man/man1/xbcrypt.1.gz
/usr/share/man/man1/xbstream.1.gz
/usr/share/man/man1/xtrabackup.1.gz

Tarball
-------
plavi@zoidberg:~/work$ tar -ztvf percona-xtrabackup-2.2.7-5061-Linux-x86_64.tar.gz |grep man
drwxr-xr-x root/root 0 2015-01-16 09:31 percona-xtrabackup-2.2.7-Linux-x86_64/man/
drwxr-xr-x root/root 0 2015-01-16 09:31 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/
-rw-r--r-- root/root 69420 2015-01-16 09:29 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/xtrabackup.1
-rw-r--r-- root/root 2084 2015-01-16 09:29 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/xbcrypt.1
-rw-r--r-- root/root 92762 2015-01-16 09:29 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/innobackupex.1
-rw-r--r-- root/root 2834 2015-01-16 09:29 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/xbstream.1

--------------------
XtraBackup 2.3 test:
--------------------
Debian Squeeze
--------------
Checked running man ... command on installed package - works fine.

Content of the package:
vagrant@t-debian6-64:~$ dpkg -c percona-xtrabackup-23_2.3.0-5062.alpha1-1.squeeze_amd64.deb |grep man
drwxr-xr-x root/root 0 2015-01-16 08:49 ./usr/share/man/
drwxr-xr-x root/root 0 2015-01-16 08:49 ./usr/share/man/man1/
-rw-r--r-- root/root 20291 2015-01-16 08:49 ./usr/share/man/man1/xtrabackup.1.gz
-rw-r--r-- root/root 817 2015-01-16 08:49 ./usr/share/man/man1/xbcrypt.1.gz
-rw-r--r-- root/root 1231 2015-01-16 08:49 ./usr/share/man/man1/xbstream.1.gz
-rw-r--r-- root/root 24293 2015-01-16 08:49 ./usr/share/man/man1/innobackupex.1.gz

Ubuntu Trusty
-------------
Checked running man ... command on installed package - works fine.

Content of the package:
vagrant@t-ubuntu1404-64:~$ dpkg -c percona-xtrabackup-23_2.3.0-5062.alpha1-1.trusty_amd64.deb |grep man
drwxr-xr-x root/root 0 2015-01-16 00:49 ./usr/share/man/
drwxr-xr-x root/root 0 2015-01-16 00:49 ./usr/share/man/man1/
-rw-r--r-- root/root 24488 2015-01-16 00:49 ./usr/share/man/man1/innobackupex.1.gz
-rw-r--r-- root/root 811 2015-01-16 00:49 ./usr/share/man/man1/xbcrypt.1.gz
-rw-r--r-- root/root 20415 2015-01-16 00:49 ./usr/share/man/man1/xtrabackup.1.gz
-rw-r--r-- root/root 1232 2015-01-16 00:49 ./usr/share/man/man1/xbstream.1.gz

Centos5
-------
Checked running man ... command on installed package - works fine.

Content of the package:
[vagrant@t-centos5-64 ~]$ rpm -qlp percona-xtrabackup-23-2.3.0-5062.alpha1.el5.x86_64.rpm |grep man
/usr/share/man/man1/innobackupex.1.gz
/usr/share/man/man1/xbcrypt.1.gz
/usr/share/man/man1/xbstream.1.gz
/usr/share/man/man1/xtrabackup.1.gz

Centos7
-------
Checked running man ... command on installed package - works fine.

Content of the package:
[vagrant@t-centos7-64 ~]$ rpm -qlp percona-xtrabackup-23-2.3.0-5062.alpha1.el7.x86_64.rpm |grep man
/usr/share/man/man1/innobackupex.1.gz
/usr/share/man/man1/xbcrypt.1.gz
/usr/share/man/man1/xbstream.1.gz
/usr/share/man/man1/xtrabackup.1.gz

Tarball
-------
plavi@zoidberg:~/work$ tar -ztvf percona-xtrabackup-2.3.0alpha1-5062-Linux-x86_64.tar.gz |grep man
drwxr-xr-x root/root 0 2015-01-16 09:49 percona-xtrabackup-2.3.0alpha1-Linux-x86_64/man/
drwxr-xr-x root/root 0 2015-01-16 09:49 percona-xtrabackup-2.3.0alpha1-Linux-x86_64/man/man1/
-rw-r--r-- root/root 69420 2015-01-16 09:47 percona-xtrabackup-2.3.0alpha1-Linux-x86_64/man/man1/xtrabackup.1
-rw-r--r-- root/root 2084 2015-01-16 09:47 percona-xtrabackup-2.3.0alpha1-Linux-x86_64/man/man1/xbcrypt.1
-rw-r--r-- root/root 92762 2015-01-16 09:47 percona-xtrabackup-2.3.0alpha1-Linux-x86_64/man/man1/innobackupex.1
-rw-r--r-- root/root 2834 2015-01-16 09:47 percona-xtrabackup-2.3.0alpha1-Linux-x86_64/man/man1/xbstream.1

[Tomislav Plavcic (tplavcic)]

Test packages are available here:
http://jenkins.percona.com/view/Percona-RELEASES/job/percona-xtrabackup-2.2-RELEASE/46/
http://jenkins.percona.com/view/Percona-RELEASES/job/percona-xtrabackup-2.3-RELEASE/4/
nevermind the yellow build for 2.3 for centos5-32 it was some connection problem and it was successful when restarted.

[Alexey Kopytov (akopytov)]

General comments:

- shouldn't we remove doc/Makefile and doc/make.bat? That would also require re-imlementing the remaining bits from Makefile in doc/source/CMakeLists.txt. How much work would that require?

- please add a CMake configuration option (-DWITH_MAN_PAGES, ON by default) so that it would be possible to build xtrabackup without man pages on systems without sphinx installed.

review: Needs Fixing

[Tomislav Plavcic (tplavcic)]

Thanks Alexey, some good comments.
1. Will check with Hrvoje which building options he actually uses and what it would take to move them.
2. Will do.

[Tomislav Plavcic (tplavcic)]

Resubmitting MP - here are the changes:
Regarding #1:
I have removed Makefile and make.bat from doc and added into cmake builds for html, latex and pdf - checked with Hrvoje and it seems that are the ones we use. Also changed jenkins documentation jobs to reflect new changes.

Regarding #2: Added option -DWITH_MAN_PAGES which is turned on by default. Also new options which are turned off by default are -DWITH_HTML_DOCS, -DWITH_LATEX_DOCS and -DWITH_PDF_DOCS and those are currently used by new jenkins documentation jobs.

Here's some testing:
PXB 2.2:
--------
TEST PACKAGES:
http://jenkins.percona.com/view/Percona-RELEASES/job/percona-xtrabackup-2.2-RELEASE/47/

RPM:
plavi@zoidberg:pxb $ rpm -qlp percona-xtrabackup-2.2.7-5061.el6.x86_64.rpm|grep man
/usr/share/man/man1/innobackupex.1.gz
/usr/share/man/man1/xbcrypt.1.gz
/usr/share/man/man1/xbstream.1.gz
/usr/share/man/man1/xtrabackup.1.gz

DEB:
plavi@zoidberg:pxb $ dpkg -c percona-xtrabackup_2.2.7-5061-1.trusty_amd64.deb|grep man
drwxr-xr-x root/root 0 2015-01-20 17:11 ./usr/share/man/
drwxr-xr-x root/root 0 2015-01-20 17:11 ./usr/share/man/man1/
-rw-r--r-- root/root 24486 2015-01-20 17:11 ./usr/share/man/man1/innobackupex.1.gz
-rw-r--r-- root/root 808 2015-01-20 17:11 ./usr/share/man/man1/xbcrypt.1.gz
-rw-r--r-- root/root 20415 2015-01-20 17:11 ./usr/share/man/man1/xtrabackup.1.gz
-rw-r--r-- root/root 1230 2015-01-20 17:11 ./usr/share/man/man1/xbstream.1.gz

TAR:
plavi@zoidberg:pxb $ tar -ztvf percona-xtrabackup-2.2.7-5061-Linux-x86_64.tar.gz|grep man
drwxr-xr-x root/root 0 2015-01-20 17:09 percona-xtrabackup-2.2.7-Linux-x86_64/man/
drwxr-xr-x root/root 0 2015-01-20 17:09 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/
-rw-r--r-- root/root 69420 2015-01-20 17:07 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/xtrabackup.1
-rw-r--r-- root/root 2084 2015-01-20 17:07 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/xbcrypt.1
-rw-r--r-- root/root 92762 2015-01-20 17:07 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/innobackupex.1
-rw-r--r-- root/root 2834 2015-01-20 17:07 percona-xtrabackup-2.2.7-Linux-x86_64/man/man1/xbstream.1

JENKINS DOCUMENTATION JOBS:
http://jenkins.percona.com/view/PXB%202.2/job/percona-xtrabackup-2.2-documentation-pdf-new/3/
http://jenkins.percona.com/view/PXB%202.2/job/percona-xtrabackup-2.2-documentation-new/1/

PXB 2.3:
--------
TEST PACKAGES:
http://jenkins.percona.com/view/Percona-RELEASES/job/percona-xtrabackup-2.3-RELEASE/6/

RPM:
plavi@zoidberg:pxb $ rpm -qlp percona-xtrabackup-23-2.3.0-5062.alpha1.el7.x86_64.rpm |grep man
/usr/share/man/man1/innobackupex.1.gz
/usr/share/man/man1/xbcrypt.1.gz
/usr/share/man/man1/xbstream.1.gz
/usr/share/man/man1/xtrabackup.1.gz

DEB:
plavi@zoidberg:pxb $ dpkg -c percona-xtrabackup-23_2.3.0-5062.alpha1-1.trusty_amd64.deb|grep man
drwxr-xr-x root/root 0 2015-01-21 09:23 ./usr/share/man/
drwxr-xr-x root/root 0 2015-01-21 09:23 ./usr/share/man/man1/
-rw-r--r-- root/root 24487 2015-01-21 09:23 ./usr/share/man/man1/innobackupex.1.gz
-rw-r--r-- root/root 811 2015-01-21 09:23 ./usr/share/man/man1/xbcrypt.1.gz
-rw-r--r-- root/root 20415 2015-01-...

=== modified file 'cmake/build_configurations/xtrabackup_release.cmake'
--- cmake/build_configurations/xtrabackup_release.cmake	2014-09-14 04:53:30 +0000
+++ cmake/build_configurations/xtrabackup_release.cmake	2015-01-20 18:10:07 +0000
@@ -52,6 +52,8 @@
 
     # Enable fast mutexes on Linux
     OPTION(WITH_FAST_MUTEXES "" ON)
+    # Enable building man pages on Linux by default
+    OPTION(WITH_MAN_PAGES "" ON)
   ENDIF()
 
 ENDIF()

=== modified file 'storage/innobase/xtrabackup/CMakeLists.txt'
--- storage/innobase/xtrabackup/CMakeLists.txt	2014-05-19 12:26:12 +0000
+++ storage/innobase/xtrabackup/CMakeLists.txt	2015-01-20 18:10:07 +0000
@@ -25,3 +25,4 @@
 
 ADD_SUBDIRECTORY(src)
 ADD_SUBDIRECTORY(test)
+ADD_SUBDIRECTORY(doc/source)

=== removed file 'storage/innobase/xtrabackup/doc/Makefile'
--- storage/innobase/xtrabackup/doc/Makefile	2014-03-26 07:39:36 +0000
+++ storage/innobase/xtrabackup/doc/Makefile	1970-01-01 00:00:00 +0000
@@ -1,143 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = build
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
-
-help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-
-clean:
-	-rm -rf $(BUILDDIR)/*
-
-html:
-	@echo "Downloading percona-theme ..."
-	@wget -O percona-theme.tar.gz http://percona.com/docs/theme/percona-xtrabackup/2.2
-	@echo "Extracting theme."
-	@tar -zxf percona-theme.tar.gz
-	@rm -rf source/percona-theme
-	@mv percona-theme source/percona-theme
-	@rm percona-theme.tar.gz
-	@echo "Building html doc"
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-offhtml:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PerconaXtraBackup.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PerconaXtraBackup.qhc"
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/PerconaXtraBackup"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PerconaXtraBackup"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	make -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."

=== removed file 'storage/innobase/xtrabackup/doc/make.bat'
--- storage/innobase/xtrabackup/doc/make.bat	2011-07-07 05:32:50 +0000
+++ storage/innobase/xtrabackup/doc/make.bat	1970-01-01 00:00:00 +0000
@@ -1,170 +0,0 @@
-@ECHO OFF
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set BUILDDIR=build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
-if NOT "%PAPER%" == "" (
-	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-)
-
-if "%1" == "" goto help
-
-if "%1" == "help" (
-	:help
-	echo.Please use `make ^<target^>` where ^<target^> is one of
-	echo.  html       to make standalone HTML files
-	echo.  dirhtml    to make HTML files named index.html in directories
-	echo.  singlehtml to make a single large HTML file
-	echo.  pickle     to make pickle files
-	echo.  json       to make JSON files
-	echo.  htmlhelp   to make HTML files and a HTML help project
-	echo.  qthelp     to make HTML files and a qthelp project
-	echo.  devhelp    to make HTML files and a Devhelp project
-	echo.  epub       to make an epub
-	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-	echo.  text       to make text files
-	echo.  man        to make manual pages
-	echo.  changes    to make an overview over all changed/added/deprecated items
-	echo.  linkcheck  to check all external links for integrity
-	echo.  doctest    to run all doctests embedded in the documentation if enabled
-	goto end
-)
-
-if "%1" == "clean" (
-	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
-	del /q /s %BUILDDIR%\*
-	goto end
-)
-
-if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
-	goto end
-)
-
-if "%1" == "dirhtml" (
-	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
-	goto end
-)
-
-if "%1" == "singlehtml" (
-	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
-	goto end
-)
-
-if "%1" == "pickle" (
-	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the pickle files.
-	goto end
-)
-
-if "%1" == "json" (
-	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the JSON files.
-	goto end
-)
-
-if "%1" == "htmlhelp" (
-	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
-	goto end
-)
-
-if "%1" == "qthelp" (
-	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PerconaXtraBackup.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PerconaXtraBackup.ghc
-	goto end
-)
-
-if "%1" == "devhelp" (
-	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished.
-	goto end
-)
-
-if "%1" == "epub" (
-	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The epub file is in %BUILDDIR%/epub.
-	goto end
-)
-
-if "%1" == "latex" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "text" (
-	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The text files are in %BUILDDIR%/text.
-	goto end
-)
-
-if "%1" == "man" (
-	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The manual pages are in %BUILDDIR%/man.
-	goto end
-)
-
-if "%1" == "changes" (
-	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.The overview file is in %BUILDDIR%/changes.
-	goto end
-)
-
-if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
-	goto end
-)
-
-if "%1" == "doctest" (
-	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
-	goto end
-)
-
-:end

=== added file 'storage/innobase/xtrabackup/doc/source/CMakeLists.txt'
--- storage/innobase/xtrabackup/doc/source/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ storage/innobase/xtrabackup/doc/source/CMakeLists.txt	2015-01-20 18:10:07 +0000
@@ -0,0 +1,75 @@
+# Copyright (c) 2013 Percona LLC and/or its affiliates.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+# generate man pages
+IF(WITH_MAN_PAGES)
+  ADD_CUSTOM_COMMAND(
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/build/man
+    COMMAND sphinx-build -b man -d build/doctrees . build/man
+    VERBATIM
+  )
+
+  ADD_CUSTOM_TARGET(man ALL
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/build/man
+  )
+
+  INSTALL(
+    CODE "FILE( GLOB MAN1_FILES \"${CMAKE_CURRENT_BINARY_DIR}/build/man/*.1\" )"
+    CODE "FILE( INSTALL \${MAN1_FILES} DESTINATION \"${INSTALL_MANDIR}/man1\" )"
+  )
+ENDIF()
+
+# generate html documentation
+IF(WITH_HTML_DOCS)
+  ADD_CUSTOM_COMMAND(
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/build/html
+    COMMAND wget -O percona-theme.tar.gz http://percona.com/docs/theme/percona-xtrabackup/2.2
+    COMMAND tar -zxf percona-theme.tar.gz
+    COMMAND rm -f percona-theme.tar.gz
+    COMMAND sphinx-build -b html -d build/doctrees . build/html
+    VERBATIM
+  )
+
+  ADD_CUSTOM_TARGET(html ALL
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/build/html
+  )
+ENDIF()
+
+# generate latex or pdf documentation
+IF(WITH_LATEX_DOCS OR WITH_PDF_DOCS)
+  ADD_CUSTOM_COMMAND(
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/build/latex
+    COMMAND sphinx-build -b latex -d build/doctrees . build/latex
+    VERBATIM
+  )
+
+  ADD_CUSTOM_TARGET(latex ALL
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/build/latex
+  )
+
+  IF(WITH_PDF_DOCS)
+    ADD_CUSTOM_COMMAND(
+      OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/build/latex/PerconaXtraBackup-2.2.pdf
+      COMMAND make -C build/latex all-pdf
+      VERBATIM
+    )
+
+    ADD_CUSTOM_TARGET(latexpdf ALL
+      DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/build/latex
+      DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/build/latex/PerconaXtraBackup-2.2.pdf
+    )
+  ENDIF()
+
+ENDIF()

=== modified file 'storage/innobase/xtrabackup/utils/build-binary.sh'
--- storage/innobase/xtrabackup/utils/build-binary.sh	2014-03-28 10:35:52 +0000
+++ storage/innobase/xtrabackup/utils/build-binary.sh	2015-01-20 18:10:07 +0000
@@ -110,7 +110,7 @@
         # Install the files
         mkdir -p "$INSTALLDIR"
         cmake -DBUILD_CONFIG=xtrabackup_release -DCMAKE_INSTALL_PREFIX="$INSTALLDIR" \
-          -DINSTALL_MYSQLTESTDIR=percona-xtrabackup-${XB_VERSION_MAJOR}.${XB_VERSION_MINOR}-test . 
+          -DINSTALL_MYSQLTESTDIR=percona-xtrabackup-${XB_VERSION_MAJOR}.${XB_VERSION_MINOR}-test -DINSTALL_MANDIR=${INSTALLDIR}/man .
         make $MAKE_JFLAG
         make install
 

=== modified file 'storage/innobase/xtrabackup/utils/debian/control'
--- storage/innobase/xtrabackup/utils/debian/control	2014-08-22 10:40:29 +0000
+++ storage/innobase/xtrabackup/utils/debian/control	2015-01-20 18:10:07 +0000
@@ -14,7 +14,9 @@
                libtool,
                libz-dev,
                libgcrypt-dev,
-               lsb-release
+               lsb-release,
+               python-sphinx (>= 1.0.1),
+               python-docutils (>= 0.6)
 Standards-Version: 3.9.5
 Homepage: http://www.percona.com/software/percona-xtrabackup
 

=== modified file 'storage/innobase/xtrabackup/utils/debian/percona-xtrabackup.install'
--- storage/innobase/xtrabackup/utils/debian/percona-xtrabackup.install	2014-06-10 11:24:27 +0000
+++ storage/innobase/xtrabackup/utils/debian/percona-xtrabackup.install	2015-01-20 18:10:07 +0000
@@ -1,1 +1,2 @@
 /usr/bin
+/usr/share/man/man1

=== modified file 'storage/innobase/xtrabackup/utils/debian/rules'
--- storage/innobase/xtrabackup/utils/debian/rules	2014-07-22 12:46:09 +0000
+++ storage/innobase/xtrabackup/utils/debian/rules	2015-01-20 18:10:07 +0000
@@ -19,7 +19,7 @@
 
 ifeq "$(DEB_DUMMY)" ""
 	cmake -DBUILD_CONFIG=xtrabackup_release -DCMAKE_INSTALL_PREFIX=/usr \
-	  -DINSTALL_MYSQLTESTDIR=/usr/share/percona-xtrabackup-test .
+	  -DINSTALL_MYSQLTESTDIR=/usr/share/percona-xtrabackup-test -DINSTALL_MANDIR=/usr/share/man .
 else
 	# Dummy binaries that avoid compilation
 	echo 'main() { return 300; }' | gcc -x c - -o xtrabackup

=== modified file 'storage/innobase/xtrabackup/utils/percona-xtrabackup.spec'
--- storage/innobase/xtrabackup/utils/percona-xtrabackup.spec	2015-01-12 09:58:23 +0000
+++ storage/innobase/xtrabackup/utils/percona-xtrabackup.spec	2015-01-20 18:10:07 +0000
@@ -17,6 +17,11 @@
 Source:         percona-xtrabackup-%{version}%{xb_version_extra}.tar.gz
 
 BuildRequires:  cmake, libaio-devel, libgcrypt-devel, ncurses-devel, readline-devel, zlib-devel
+%if 0%{?rhel} > 6
+BuildRequires:  python-sphinx >= 1.0.1, python-docutils >= 0.6
+%else
+BuildRequires:  python-sphinx10 >= 1.0.1, python-docutils >= 0.6
+%endif
 Requires:       perl(DBD::mysql), rsync
 BuildRoot:      %{_tmppath}/%{name}-%{version}-root
 
@@ -54,7 +59,7 @@
 export CXXFLAGS="$CXXFLAGS -DXTRABACKUP_VERSION=\\\"%{xtrabackup_version}\\\" -DXTRABACKUP_REVISION=\\\"%{xtrabackup_revision}\\\""
 #
 cmake -DBUILD_CONFIG=xtrabackup_release -DCMAKE_INSTALL_PREFIX=%{_prefix} \
-  -DINSTALL_MYSQLTESTDIR=%{_datadir}/percona-xtrabackup-test .
+  -DINSTALL_MYSQLTESTDIR=%{_datadir}/percona-xtrabackup-test -DINSTALL_MANDIR=%{_mandir} .
 #
 make %{?_smp_mflags}
 #
@@ -74,6 +79,7 @@
 %{_bindir}/xbstream
 %{_bindir}/xbcrypt
 %doc COPYING
+%doc %{_mandir}/man1/*.1.gz
 
 %files -n percona-xtrabackup-test
 %defattr(-,root,root,-)