Merge lp:~linuxjedi/mydumper/trunk-sphinx-docs into lp:~mydumper/mydumper/trunk

[Andrew Hutchings]

Add python-sphinx docs builder and very basic documentation (will expand later)

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2011-04-21 20:52:39 +0000
+++ CMakeLists.txt	2011-04-26 14:57:22 +0000
@@ -10,6 +10,8 @@
 find_package(GLIB2)
 find_package(PCRE)
 
+add_subdirectory(docs)
+
 set(CMAKE_C_FLAGS "-Wall -Werror -O3 -g")
 
 include_directories(${MYDUMPER_SOURCE_DIR} ${MYSQL_INCLUDE_DIR} ${GLIB2_INCLUDE_DIR} ${PCRE_INCLUDE_DIR} ${ZLIB_INCLUDE_DIRS})

=== added file 'cmake/modules/FindSphinx.cmake'
--- cmake/modules/FindSphinx.cmake	1970-01-01 00:00:00 +0000
+++ cmake/modules/FindSphinx.cmake	2011-04-26 14:57:22 +0000
@@ -0,0 +1,37 @@
+# - This module looks for Sphinx
+# Find the Sphinx documentation generator
+#
+# This modules defines
+#  SPHINX_EXECUTABLE
+#  SPHINX_FOUND
+
+#=============================================================================
+# Copyright 2002-2009 Kitware, Inc.
+# Copyright 2009-2011 Peter Colberg
+#
+# Distributed under the OSI-approved BSD License (the "License");
+# see accompanying file COPYING-CMAKE-SCRIPTS for details.
+#
+# This software is distributed WITHOUT ANY WARRANTY; without even the
+# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the License for more information.
+#=============================================================================
+# (To distribute this file outside of CMake, substitute the full
+#  License text for the above reference.)
+
+find_program(SPHINX_EXECUTABLE NAMES sphinx-build
+  HINTS
+  $ENV{SPHINX_DIR}
+  PATH_SUFFIXES bin
+  DOC "Sphinx documentation generator"
+)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(Sphinx DEFAULT_MSG
+  SPHINX_EXECUTABLE
+)
+
+mark_as_advanced(
+  SPHINX_EXECUTABLE
+)

=== added directory 'docs'
=== added file 'docs/CMakeLists.txt'
--- docs/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ docs/CMakeLists.txt	2011-04-26 14:57:22 +0000
@@ -0,0 +1,153 @@
+# Generate documentation in HTML and PDF format using Sphinx.
+
+set(GENERATE_DOC TRUE)
+
+# We use the Sphinx documentation generator to render HTML and manual
+# pages from the user and reference documentation in ReST format.
+find_package(Sphinx QUIET)
+if(NOT SPHINX_FOUND)
+  message(WARNING "Unable to find Sphinx documentation generator")
+  set(GENERATE_DOC FALSE)
+endif(NOT SPHINX_FOUND)
+
+if(GENERATE_DOC)
+  # documentation tools
+  set(SOURCE_BUILD_DIR "${CMAKE_CURRENT_SOURCE_DIR}/_build")
+  # configured documentation tools and intermediate build results
+  set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build")
+  # static ReST documentation sources
+  set(SOURCES_DIR "${CMAKE_CURRENT_BINARY_DIR}/_sources")
+  # generated ReST documentation sources
+  set(REF_SOURCES_DIR "${SOURCES_DIR}/reference")
+  # master document with modules index
+  set(REF_MASTER_DOC "modules")
+
+  # substitute variables in configuration and scripts
+  foreach(file
+      conf.py
+      sources.cmake
+  )
+    configure_file(
+      "${SOURCE_BUILD_DIR}/${file}.in"
+      "${BINARY_BUILD_DIR}/${file}"
+      @ONLY
+    )
+  endforeach(file)
+
+  set(CLEAN_FILES
+    "${BINARY_BUILD_DIR}/html"
+  )
+
+  add_custom_target(ALL
+    DEPENDS "${REF_SOURCES_DIR}/${REF_MASTER_DOC}.rst"
+  )
+
+  # Sphinx requires all sources in the same directory tree. As we wish
+  # to include generated reference documention from the build tree, we
+  # copy static ReST documents to the build tree before calling Sphinx.
+  add_custom_target(doc_sources ALL
+    "${CMAKE_COMMAND}" -P "${BINARY_BUILD_DIR}/sources.cmake"
+  )
+  list(APPEND CLEAN_FILES
+    "${SOURCES_DIR}"
+  )
+
+  # note the trailing slash to exclude directory name
+  install(DIRECTORY "${SOURCES_DIR}/"
+    DESTINATION "share/doc/mydumper"
+  )
+
+  # Sphinx cache with pickled ReST documents
+  set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees")
+  # HTML output directory
+  set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/html")
+
+  # This target builds HTML documentation using Sphinx.
+  add_custom_target(doc_html ALL
+    ${SPHINX_EXECUTABLE}
+      -q -b html
+      -c "${BINARY_BUILD_DIR}"
+      -d "${SPHINX_CACHE_DIR}"
+      "${SOURCES_DIR}"
+      "${SPHINX_HTML_DIR}"
+    COMMENT "Building HTML documentation with Sphinx"
+  )
+  list(APPEND CLEAN_FILES
+    "${SPHINX_CACHE_DIR}"
+    "${SPHINX_HTML_DIR}"
+  )
+  add_dependencies(doc_html
+    doc_sources
+  )
+  install(DIRECTORY "${SPHINX_HTML_DIR}"
+    DESTINATION "share/doc/mydumper"
+  )
+
+  # HTML output directory
+  set(SPHINX_MAN_DIR "${CMAKE_CURRENT_BINARY_DIR}/man")
+  # This target builds a manual page using Sphinx.
+
+  add_custom_target(doc_man ALL
+    ${SPHINX_EXECUTABLE}
+      -q -b man
+      -c "${BINARY_BUILD_DIR}"
+      -d "${SPHINX_CACHE_DIR}"
+      "${SOURCES_DIR}"
+      "${SPHINX_MAN_DIR}"
+    COMMENT "Building manual page with Sphinx"
+  )
+  list(APPEND CLEAN_FILES
+    "${SPHINX_MAN_DIR}"
+  )
+  add_dependencies(doc_man
+    doc_sources
+  )
+  # serialize Sphinx targets to avoid cache conflicts in parallel builds
+  add_dependencies(doc_man
+    doc_html
+  )
+  install(FILES "${SPHINX_MAN_DIR}/mysqldatadumper.1"
+    DESTINATION "share/man/man1"
+  )
+
+  # This target builds PDF documentation using Sphinx and LaTeX.
+  if(PDFLATEX_COMPILER)
+    # PDF output directory
+    set(SPHINX_PDF_DIR "${CMAKE_CURRENT_BINARY_DIR}/pdf")
+
+    add_custom_target(doc_pdf ALL
+      ${SPHINX_EXECUTABLE}
+	-q -b latex
+	-c "${BINARY_BUILD_DIR}"
+	-d "${SPHINX_CACHE_DIR}"
+	"${SOURCES_DIR}"
+	"${SPHINX_PDF_DIR}"
+      COMMENT "Building PDF documentation with Sphinx"
+    )
+    add_custom_command(TARGET doc_pdf POST_BUILD
+      COMMAND ${CMAKE_MAKE_PROGRAM} LATEXOPTS=-interaction=batchmode
+      WORKING_DIRECTORY "${SPHINX_PDF_DIR}"
+    )
+    list(APPEND CLEAN_FILES
+      "${SPHINX_PDF_DIR}"
+    )
+    add_dependencies(doc_pdf
+      doc_sources
+    )
+    # serialize Sphinx targets to avoid cache conflicts in parallel builds
+    add_dependencies(doc_pdf
+      doc_man
+    )
+    install(FILES "${SPHINX_PDF_DIR}/mydumper.pdf"
+      DESTINATION "share/doc/mydumper"
+    )
+  endif(PDFLATEX_COMPILER)
+
+  # Add output directories to clean target.
+  set_directory_properties(PROPERTIES
+    ADDITIONAL_MAKE_CLEAN_FILES "${CLEAN_FILES}"
+  )
+
+else(GENERATE_DOC)
+  message(WARNING "Missing required documentation tools")
+endif(GENERATE_DOC)

=== added directory 'docs/_build'
=== added file 'docs/_build/conf.py.in'
--- docs/_build/conf.py.in	1970-01-01 00:00:00 +0000
+++ docs/_build/conf.py.in	2011-04-26 14:57:22 +0000
@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# MySQL Data Dumper documentation build configuration file, created by
+# sphinx-quickstart on Tue Apr 26 11:44:25 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.todo']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'@PROJECT_NAME@'
+copyright = u'2011, Andrew Hutchings'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MySQLDataDumperdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'MySQLDataDumper.tex', u'@PROJECT_NAME@ Documentation',
+   u'Andrew Hutchings', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'mysqldatadumper', u'@PROGRAM_DESC@',
+     [u'Andrew Hutchings'], 1)
+]

=== added file 'docs/_build/sources.cmake.in'
--- docs/_build/sources.cmake.in	1970-01-01 00:00:00 +0000
+++ docs/_build/sources.cmake.in	2011-04-26 14:57:22 +0000
@@ -0,0 +1,16 @@
+# This script recursively copies all ReST documents from the source directory to
+# the binary directory. CMAKE_CURRENT_SOURCE_DIR and SOURCES_DIR are substituted
+# upon the cmake stage. The script is executed upon the make stage to ensure
+# that the binary sources directory is always up to date.
+
+file(GLOB_RECURSE SOURCES
+  RELATIVE "@CMAKE_CURRENT_SOURCE_DIR@"
+  "@CMAKE_CURRENT_SOURCE_DIR@/*.rst"
+)
+foreach(source ${SOURCES})
+  configure_file(
+    "@CMAKE_CURRENT_SOURCE_DIR@/${source}"
+    "@SOURCES_DIR@/${source}"
+    COPYONLY
+    )
+endforeach(source)

=== added directory 'docs/_static'
=== added file 'docs/index.rst'
--- docs/index.rst	1970-01-01 00:00:00 +0000
+++ docs/index.rst	2011-04-26 14:57:22 +0000
@@ -0,0 +1,20 @@
+.. MySQL Data Dumper documentation master file
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to MySQL Data Dumper's documentation!
+=============================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`
+

=== added file 'docs/usage.rst'
--- docs/usage.rst	1970-01-01 00:00:00 +0000
+++ docs/usage.rst	2011-04-26 14:57:22 +0000
@@ -0,0 +1,102 @@
+MySQL Data Dumper Usage
+=======================
+
+Synopsis
+--------
+
+:program:`mydumper`
+
+Description
+-----------
+
+:program:`mydumper` is a tool used for backing up MySQL database servers much
+faster than the mysqldump tool distributed with MySQL.
+
+Options
+-------
+
+The :program:`mydumper` tool has several available options:
+
+.. program:: mydumper
+
+.. option:: --help, -?
+
+   Show help text
+
+.. option:: --host, -h
+
+   Hostname of MySQL server to connect to (default localhost)
+
+.. option:: --user, -u
+
+   MySQL username with the correct privileges to execute the dump
+
+.. option:: --password, -p
+
+   The corresponding password for the MySQL user
+
+.. option:: --port, -P
+
+   The port for the MySQL connection.
+
+   .. note::
+
+      For localhost TCP connections use 127.0.0.1 for :option:`--host`.
+
+.. option:: --socket, -S
+
+   The UNIX domain socket file to use for the connection
+
+.. option:: --database, -B
+
+   Database to dump
+
+.. option:: --table-list, -T
+
+   A comma separated list of tables to dump
+
+.. option:: --threads, -t
+
+   The number of threads to use for dumping data, default is 4
+
+.. option:: --outputdir, -o
+
+   Output directory name, default is export-YYYYMMDD-HHMMSS
+
+.. option:: --statement-size, -s
+
+   The maximum size for an insert statement before breaking into a new
+   statement, default 1,000,000 bytes
+
+.. option:: --rows, -r
+
+   Split table into chunks of this many rows, default unlimited
+
+.. option:: --compress, -c
+
+   Compress the output files
+
+.. option:: --build-empty-files, -e
+
+   Create empty dump files if there is no data to dump
+
+.. option:: --regex, -x
+
+   A regular expression to match against database and table
+
+.. option:: --ignore-engines, -i
+
+   Comma separated list of storage engines to ignore
+
+.. option:: --long-query-guard, -l
+
+   Timeout for long query execution in seconds, default 60
+
+.. option:: --kill-long-queries, -k
+
+   Kill long running queries instead of aborting the dump
+
+.. option:: --version, -V
+
+   Show the program version and exit
+