Merge pull request #1607 from satya-bodapati/8.0

Revert PXB-3316 completely

README.md

@@ -1,7 +1,7 @@
 
 ## Percona XtraBackup
 
-![PXB logo](storage/innobase/xtrabackup/percona-xtrabackup-logo.jpg)
+![PXB logo](storage/innobase/xtrabackup/doc/source/percona-xtrabackup-logo.jpg)
 
 Percona XtraBackup is an open-source hot backup utility for MySQL - based servers that doesn’t lock your database during the backup.
 

cmake/make_dist.cmake.in

@@ -142,6 +142,18 @@ IF(NOT EXISTS ${PACKAGE_DIR}/Docs/INFO_SRC)
  CREATE_INFO_SRC(${PACKAGE_DIR}/Docs)
 ENDIF()
 
+# Add xtrabackup man pages
+SET(MAN_BIN_DIR ${CMAKE_CURRENT_BINARY_DIR}/storage/innobase/xtrabackup/doc/source/build/man)
+SET(MAN_PKG_DIR ${PACKAGE_DIR}/storage/innobase/xtrabackup/doc/source/build/man)
+
+IF(EXISTS ${MAN_BIN_DIR})
+ FILE(GLOB MAN_FILES RELATIVE ${MAN_BIN_DIR} ${MAN_BIN_DIR}/*.1)
+ FOREACH(MAN_FILE ${MAN_FILES})
+ CONFIGURE_FILE(${MAN_BIN_DIR}/${MAN_FILE}
+ ${MAN_PKG_DIR}/${MAN_FILE} COPYONLY)
+ ENDFOREACH()
+ENDIF()
+
 # In case we used CPack, it could have copied some
 # extra files that are not usable on different machines.
 FILE(REMOVE ${PACKAGE_DIR}/CMakeCache.txt)

man/CMakeLists.txt

@@ -26,10 +26,6 @@ FILE(GLOB MAN1_NDB ndb*.1)
 FILE(GLOB MAN8 *.8)
 FILE(GLOB MAN8_NDB ndb*.8)
 
-IF (WITH_XTRABACKUP)
- RETURN()
-ENDIF()
-
 IF(MAN1_NDB AND NOT WITH_NDB)
  LIST(REMOVE_ITEM MAN1 ${MAN1_NDB})
 ENDIF()

sql/CMakeLists.txt

@@ -1237,6 +1237,10 @@ ADD_CUSTOM_TARGET(dist
  WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
 )
 
+IF(WITH_MAN_PAGES)
+ ADD_DEPENDENCIES(dist man)
+ENDIF()
+
 ADD_CUSTOM_TARGET(distclean
  COMMAND ${CMAKE_COMMAND} -E echo WARNING: distclean target is not functional
  COMMAND ${CMAKE_COMMAND} -E echo Use 'git clean -fdx' instead

storage/innobase/xtrabackup/CMakeLists.txt

@@ -24,6 +24,7 @@ INSTALL_SCRIPT(${CMAKE_CURRENT_BINARY_DIR}/xbcloud_osenv
  )
 
 ADD_SUBDIRECTORY(src)
+ADD_SUBDIRECTORY(doc/source)
 
 IF(INSTALL_MYSQLTESTDIR)
  INSTALL(

storage/innobase/xtrabackup/doc/.gitignore

@@ -0,0 +1,4 @@
+build/
+source/ext/psdom.pyc
+source/percona-theme/
+COMMIT_MESSAGE

storage/innobase/xtrabackup/doc/Makefile

@@ -0,0 +1,103 @@
+# 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 " offhtml to make standalone HTML files without fetching the new theme files"
+ @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)/*
+
+
+
+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/PerconaServer.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PerconaServer.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/PerconaServer"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PerconaServer"
+ @echo "# devhelp"
+
+
+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: ext
+ $(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."
+

storage/innobase/xtrabackup/doc/_resource/overrides/404.html

@@ -0,0 +1,9 @@
+{#-
+ This file was automatically generated - do not edit
+-#}
+{% extends "main.html" %}
+{% block content %}
+ <h1>404 - Not found</h1>
+ <p> 
+We can't find the page you are looking for. Try using the Search or <a href= "{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"> return to homepage </a>. </p>
+{% endblock %}

storage/innobase/xtrabackup/doc/_resource/overrides/main.html

@@ -0,0 +1,59 @@
+{#
+MkDocs template for Netlify builds to customize docs layout 
+by adding marketing-requested elements
+#}
+
+{# Import the theme's layout. #}
+{% extends "base.html" %}
+
+{%- macro relbar2 () %}
+<div class="md-relbar2__inner md-grid">
+<div class="md-content">
+ <article class="md-content__inner md-typeset" role="main"> 
+ <h4>Contact Us </h4>
+ <p>For free technical help, visit the Percona <a class="reference external" href="https://forums.percona.com/c/mysql-mariadb/percona-xtrabackup/10?utm_campaign=Doc%20pages" target="_blank">Community Forum</a>.<br>
+ <p>To report bugs or submit feature requests, open a <a class="reference external" href="https://jira.percona.com/projects/PXB/issues/" target="_blank">JIRA</a> ticket.<br>
+ <p>For paid <a class="reference external" href="https://www.percona.com/services/support"> support </a> and <a class="reference external" href="https://www.percona.com/services/managed-services"> managed </a> or <a class="reference external" href="https://www.percona.com/services/consulting">consulting services </a>, contact <a class="reference external" href="https://www.percona.com/about-percona/contact" target="_blank">Percona Sales</a>.</p>
+ </article>
+</div>
+</div>
+{%- endmacro %}
+
+ {% block content %}
+
+ <!-- Edit button -->
+ {% if page.edit_url %}
+ <a
+ href="{{ page.edit_url }}"
+ title="{{ lang.t('edit.link.title') }}"
+ class="md-content__button md-icon"
+ >
+ {% include ".icons/material/pencil.svg" %}
+ </a>
+ {% endif %}
+
+ <!--
+ Hack: check whether the content contains a h1 headline. If it
+ doesn't, the page title (or respectively site name) is used
+ as the main headline.
+ -->
+ {% if not "\x3ch1" in page.content %}
+ <h1>{{ page.title | d(config.site_name, true)}}</h1>
+ {% endif %}
+
+ <!-- Markdown content -->
+ {{ page.content }}
+
+ {{ relbar2() }}
+
+ <!-- Last update of source file -->
+ {% if page and page.meta %}
+ {% if page.meta.git_revision_date_localized or
+ page.meta.revision_date
+ %}
+ {% include "partials/source-file.html" %}
+ {% endif %}
+ {% endif %}
+ {% endblock %}
+
+

storage/innobase/xtrabackup/doc/_resource/overrides/partials/header.html

@@ -0,0 +1,77 @@
+{#-
+ This file was automatically generated - do not edit
+-#}
+<header class="md-header" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="{{ lang.t('header.title') }}">
+ <a href="https://percona.com/software/documentation" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
+ {% include "partials/logo.html" %}
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+ {% include ".icons/material/menu" ~ ".svg" %}
+ </label>
+ <div class="md-header__title" data-md-component="header-title">
+ <div class="md-header__ellipsis">
+ <div class="md-header__topic">
+ <span class="md-ellipsis"><a href="https://www.percona.com/software/documentation">
+ Percona Product Documentation
+ </a></span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+ {% if page and page.meta and page.meta.title %}
+ {{ page.meta.title }}
+ {% else %}
+ {{ page.title }}
+ {% endif %}
+ </span>
+ </div>
+ </div>
+ </div>
+ {% if not config.theme.palette is mapping %}
+ <form class="md-header__option" data-md-component="palette">
+ {% for option in config.theme.palette %}
+ {% set primary = option.primary | replace(" ", "-") | lower %}
+ {% set accent = option.accent | replace(" ", "-") | lower %}
+ <input class="md-option" data-md-color-media="{{ option.media }}" data-md-color-scheme="{{ option.scheme }}" data-md-color-primary="{{ primary }}" data-md-color-accent="{{ accent }}" type="radio" name="__palette" id="__palette_{{ loop.index }}">
+ {% if option.toggle %}
+ <label class="md-header__button md-icon" title="{{ option.toggle.name }}" for="__palette_{{ loop.index0 or loop.length }}" hidden>
+ {% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
+ </label>
+ {% endif %}
+ {% endfor %}
+ </form>
+ {% endif %}
+ {% if config.extra.alternate %}
+ <div class="md-header__option">
+ <div class="md-select">
+ {% set icon = config.theme.icon.alternate or "material/translate" %}
+ <button class="md-header__button md-icon">
+ {% include ".icons/" ~ icon ~ ".svg" %}
+ </button>
+ <div class="md-select__inner">
+ <ul class="md-select__list">
+ {% for alt in config.extra.alternate %}
+ <li class="md-select__item">
+ <a href="{{ alt.link | url }}" hreflang="{{ alt.lang }}" class="md-select__link">
+ {{ alt.name }}
+ </a>
+ </li>
+ {% endfor %}
+ </ul>
+ </div>
+ </div>
+ </div>
+ {% endif %}
+ {% if "search" in config["plugins"] %}
+ <label class="md-header__button md-icon" for="__search">
+ {% include ".icons/material/magnify.svg" %}
+ </label>
+ {% include "partials/search.html" %}
+ {% endif %}
+ {% if config.repo_url %}
+ <div class="md-header__source">
+ {% include "partials/source.html" %}
+ </div>
+ {% endif %}
+ </nav>
+</header>

storage/innobase/xtrabackup/doc/_resource/overrides/partials/nav.html

@@ -0,0 +1,36 @@
+{#-
+ This file was automatically generated - do not edit
+-#}
+{% set class = "md-nav md-nav--primary" %}
+{% if "navigation.tabs" in features %}
+ {% set class = class ~ " md-nav--lifted" %}
+{% endif %}
+{% if "toc.integrate" in features %}
+ {% set class = class ~ " md-nav--integrated" %}
+{% endif %}
+<nav class="{{ class }}" aria-label="{{ lang.t('nav.title') }}" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-nav__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
+ {% include "partials/logo.html" %}
+ </a>
+ {{ config.site_name }}
+ </label>
+ {% if config.repo_url %}
+ <div class="md-nav__source">
+ {% include "partials/source.html" %}
+ </div>
+ {% endif %}
+ <ul class="md-nav__list" data-md-scrollfix>
+ {% for nav_item in nav %}
+ {% set path = "__nav_" ~ loop.index %}
+ {% set level = 1 %}
+ {% include "partials/nav-item.html" %}
+ {% endfor %}
+ <label class="md-nav__title" for="__drawer">
+ <a href="https://learn.percona.com/download-percona-xtrabackup-8.0-manual" onclick="_gaq.push(['b._trackEvent', 'Percona XtraBackup', 'Download', 'Download Manual Percona XtraBackup']);" class="md-nav__link md-nav__link--active">
+ Download PDF
+ </a>
+ </label> 
+ </ul>
+</nav>
+