summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Modules/CMakeGraphVizOptions.cmake109
-rw-r--r--Modules/CPack.cmake465
-rw-r--r--Modules/CPackBundle.cmake52
-rw-r--r--Modules/CPackComponent.cmake113
-rw-r--r--Modules/CPackCygwin.cmake30
-rw-r--r--Modules/CPackDMG.cmake101
-rw-r--r--Modules/CPackDeb.cmake250
-rw-r--r--Modules/CPackNSIS.cmake231
-rw-r--r--Modules/CPackPackageMaker.cmake40
-rw-r--r--Modules/CPackRPM.cmake450
-rw-r--r--Modules/CPackWIX.cmake152
11 files changed, 805 insertions, 1188 deletions
diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake
index 63009dc..f2b8e59 100644
--- a/Modules/CMakeGraphVizOptions.cmake
+++ b/Modules/CMakeGraphVizOptions.cmake
@@ -4,108 +4,95 @@
#
# The builtin graphviz support of CMake.
#
-# #section Variables specific to the graphviz support #end #module CMake
+# Variables specific to the graphviz support
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#
+# CMake
# can generate graphviz files, showing the dependencies between the
# targets in a project and also external libraries which are linked
# against. When CMake is run with the --graphiz=foo option, it will
# produce
#
-# ::
-#
-# * a foo.dot file showing all dependencies in the project
-# * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends
-# * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target
-#
-#
+# * a foo.dot file showing all dependencies in the project
+# * a foo.dot.<target> file for each target, file showing on which other targets the respective target depends
+# * a foo.dot.<target>.dependers file, showing which other targets depend on the respective target
#
# This can result in huge graphs. Using the file
# CMakeGraphVizOptions.cmake the look and content of the generated
# graphs can be influenced. This file is searched first in
# ${CMAKE_BINARY_DIR} and then in ${CMAKE_SOURCE_DIR}. If found, it is
# read and the variables set in it are used to adjust options for the
-# generated graphviz files. #end
-#
-# #variable
+# generated graphviz files.
#
-# ::
+# .. variable:: GRAPHVIZ_GRAPH_TYPE
#
-# GRAPHVIZ_GRAPH_TYPE - The graph type
-# Mandatory : NO
-# Default : "digraph"
+# The graph type
#
-# #end #variable
+# * Mandatory : NO
+# * Default : "digraph"
#
-# ::
+# .. variable:: GRAPHVIZ_GRAPH_NAME
#
-# GRAPHVIZ_GRAPH_NAME - The graph name.
-# Mandatory : NO
-# Default : "GG"
+# The graph name.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : "GG"
#
-# ::
+# .. variable:: GRAPHVIZ_GRAPH_HEADER
#
-# GRAPHVIZ_GRAPH_HEADER - The header written at the top of the graphviz file.
-# Mandatory : NO
-# Default : "node [n fontsize = "12"];"
+# The header written at the top of the graphviz file.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : "node [n fontsize = "12"];"
#
-# ::
+# .. variable:: GRAPHVIZ_NODE_PREFIX
#
-# GRAPHVIZ_NODE_PREFIX - The prefix for each node in the graphviz file.
-# Mandatory : NO
-# Default : "node"
+# The prefix for each node in the graphviz file.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : "node"
#
-# ::
+# .. variable:: GRAPHVIZ_EXECUTABLES
#
-# GRAPHVIZ_EXECUTABLES - Set this to FALSE to exclude executables from the generated graphs.
-# Mandatory : NO
-# Default : TRUE
+# Set this to FALSE to exclude executables from the generated graphs.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : TRUE
#
-# ::
+# .. variable:: GRAPHVIZ_STATIC_LIBS
#
-# GRAPHVIZ_STATIC_LIBS - Set this to FALSE to exclude static libraries from the generated graphs.
-# Mandatory : NO
-# Default : TRUE
+# Set this to FALSE to exclude static libraries from the generated graphs.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : TRUE
#
-# ::
+# .. variable:: GRAPHVIZ_SHARED_LIBS
#
-# GRAPHVIZ_SHARED_LIBS - Set this to FALSE to exclude shared libraries from the generated graphs.
-# Mandatory : NO
-# Default : TRUE
+# Set this to FALSE to exclude shared libraries from the generated graphs.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : TRUE
#
-# ::
+# .. variable:: GRAPHVIZ_MODULE_LIBS
#
-# GRAPHVIZ_MODULE_LIBS - Set this to FALSE to exclude module libraries from the generated graphs.
-# Mandatory : NO
-# Default : TRUE
+# Set this to FALSE to exclude module libraries from the generated graphs.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : TRUE
#
-# ::
+# .. variable:: GRAPHVIZ_EXTERNAL_LIBS
#
-# GRAPHVIZ_EXTERNAL_LIBS - Set this to FALSE to exclude external libraries from the generated graphs.
-# Mandatory : NO
-# Default : TRUE
+# Set this to FALSE to exclude external libraries from the generated graphs.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : TRUE
#
-# ::
+# .. variable:: GRAPHVIZ_IGNORE_TARGETS
#
-# GRAPHVIZ_IGNORE_TARGETS - A list of regular expressions for ignoring targets.
-# Mandatory : NO
-# Default : empty
+# A list of regular expressions for ignoring targets.
#
-# #end
+# * Mandatory : NO
+# * Default : empty
#=============================================================================
# Copyright 2007-2009 Kitware, Inc.
diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake
index 1dcc65d..da6b2e0 100644
--- a/Modules/CPack.cmake
+++ b/Modules/CPack.cmake
@@ -4,7 +4,10 @@
#
# Build binary and source package installers.
#
-# #section Variables common to all CPack generators #end #module The
+# Variables common to all CPack generators
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#
+# The
# CPack module generates binary and source installers in a variety of
# formats using the cpack program. Inclusion of the CPack module adds
# two new targets to the resulting makefiles, package and
@@ -35,24 +38,16 @@
#
# Here's how it works:
#
-# ::
-#
-# - cpack runs
-# - it includes CPackConfig.cmake
-# - it iterates over the generators listed in that file's
-# CPACK_GENERATOR list variable (unless told to use just a
-# specific one via -G on the command line...)
-#
-#
-#
-# ::
-#
-# - foreach generator, it then
-# - sets CPACK_GENERATOR to the one currently being iterated
-# - includes the CPACK_PROJECT_CONFIG_FILE
-# - produces the package for that generator
-#
+# * cpack runs
+# * it includes CPackConfig.cmake
+# * it iterates over the generators listed in that file's
+# CPACK_GENERATOR list variable (unless told to use just a
+# specific one via -G on the command line...)
+# * foreach generator, it then
#
+# - sets CPACK_GENERATOR to the one currently being iterated
+# - includes the CPACK_PROJECT_CONFIG_FILE
+# - produces the package for that generator
#
# This is the key: For each generator listed in CPACK_GENERATOR in
# CPackConfig.cmake, cpack will *reset* CPACK_GENERATOR internally to
@@ -61,368 +56,211 @@
#
# Before including this CPack module in your CMakeLists.txt file, there
# are a variety of variables that can be set to customize the resulting
-# installers. The most commonly-used variables are: #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_NAME - The name of the package (or application). If
-# not specified, defaults to the project name.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_VENDOR - The name of the package vendor. (e.g.,
-# "Kitware").
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_DIRECTORY - The directory in which CPack is doing its
-# packaging. If it is not set then this will default (internally) to the
-# build dir. This variable may be defined in CPack config file or from
-# the cpack command line option "-B". If set the command line option
-# override the value found in the config file.
-#
-# #end
-#
-# #variable
-#
-# ::
+# installers. The most commonly-used variables are:
#
-# CPACK_PACKAGE_VERSION_MAJOR - Package major Version
+# .. variable:: CPACK_PACKAGE_NAME
#
-# #end
+# The name of the package (or application). If not specified, defaults to
+# the project name.
#
-# #variable
+# .. variable:: CPACK_PACKAGE_VENDOR
#
-# ::
+# The name of the package vendor. (e.g., "Kitware").
#
-# CPACK_PACKAGE_VERSION_MINOR - Package minor Version
+# .. variable:: CPACK_PACKAGE_DIRECTORY
#
-# #end
+# The directory in which CPack is doing its packaging. If it is not set
+# then this will default (internally) to the build dir. This variable may
+# be defined in CPack config file or from the cpack command line option
+# "-B". If set the command line option override the value found in the
+# config file.
#
-# #variable
+# .. variable:: CPACK_PACKAGE_VERSION_MAJOR
#
-# ::
+# Package major Version
#
-# CPACK_PACKAGE_VERSION_PATCH - Package patch Version
+# .. variable:: CPACK_PACKAGE_VERSION_MINOR
#
-# #end
+# Package minor Version
#
-# #variable
+# .. variable:: CPACK_PACKAGE_VERSION_PATCH
#
-# ::
+# Package patch Version
#
-# CPACK_PACKAGE_DESCRIPTION_FILE - A text file used to describe the
-# project. Used, for example, the introduction screen of a
-# CPack-generated Windows installer to describe the project.
+# .. variable:: CPACK_PACKAGE_DESCRIPTION_FILE
#
-# #end
+# A text file used to describe the project. Used, for example, the
+# introduction screen of a CPack-generated Windows installer to describe
+# the project.
#
-# #variable
+# .. variable:: CPACK_PACKAGE_DESCRIPTION_SUMMARY
#
-# ::
+# Short description of the project (only a few words).
#
-# CPACK_PACKAGE_DESCRIPTION_SUMMARY - Short description of the
-# project (only a few words).
+# .. variable:: CPACK_PACKAGE_FILE_NAME
#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_FILE_NAME - The name of the package file to generate,
-# not including the extension. For example, cmake-2.6.1-Linux-i686.
-# The default value is
-#
-#
-#
-# ::
+# The name of the package file to generate, not including the
+# extension. For example, cmake-2.6.1-Linux-i686. The default value is::
#
# ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CPACK_SYSTEM_NAME}.
#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_INSTALL_DIRECTORY - Installation directory on the
-# target system. This may be used by some CPack generators
-# like NSIS to create an installation directory e.g., "CMake 2.5"
-# below the installation prefix. All installed element will be
-# put inside this directory.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_ICON - A branding image that will be displayed inside
-# the installer (used by GUI installers).
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PROJECT_CONFIG_FILE - CPack-time project CPack configuration
-# file. This file included at cpack time, once per
-# generator after CPack has set CPACK_GENERATOR to the actual generator
-# being used. It allows per-generator setting of CPACK_* variables at
-# cpack time.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_RESOURCE_FILE_LICENSE - License to be embedded in the installer. It
-# will typically be displayed to the user by the produced installer
-# (often with an explicit "Accept" button, for graphical installers)
-# prior to installation. This license file is NOT added to installed
-# file but is used by some CPack generators like NSIS. If you want
-# to install a license file (may be the same as this one)
-# along with your project you must add an appropriate CMake INSTALL
-# command in your CMakeLists.txt.
+# .. variable:: CPACK_PACKAGE_INSTALL_DIRECTORY
#
-# #end
+# Installation directory on the target system. This may be used by some
+# CPack generators like NSIS to create an installation directory e.g.,
+# "CMake 2.5" below the installation prefix. All installed element will be
+# put inside this directory.
#
-# #variable
+# .. variable:: CPACK_PACKAGE_ICON
#
-# ::
+# A branding image that will be displayed inside the installer (used by GUI
+# installers).
#
-# CPACK_RESOURCE_FILE_README - ReadMe file to be embedded in the installer. It
-# typically describes in some detail the purpose of the project
-# during the installation. Not all CPack generators uses
-# this file.
+# .. variable:: CPACK_PROJECT_CONFIG_FILE
#
-# #end
+# CPack-time project CPack configuration file. This file included at cpack
+# time, once per generator after CPack has set CPACK_GENERATOR to the
+# actual generator being used. It allows per-generator setting of CPACK_*
+# variables at cpack time.
#
-# #variable
+# .. variable:: CPACK_RESOURCE_FILE_LICENSE
#
-# ::
+# License to be embedded in the installer. It will typically be displayed
+# to the user by the produced installer (often with an explicit "Accept"
+# button, for graphical installers) prior to installation. This license
+# file is NOT added to installed file but is used by some CPack generators
+# like NSIS. If you want to install a license file (may be the same as this
+# one) along with your project you must add an appropriate CMake INSTALL
+# command in your CMakeLists.txt.
#
-# CPACK_RESOURCE_FILE_WELCOME - Welcome file to be embedded in the
-# installer. It welcomes users to this installer.
-# Typically used in the graphical installers on Windows and Mac OS X.
+# .. variable:: CPACK_RESOURCE_FILE_README
#
-# #end
+# ReadMe file to be embedded in the installer. It typically describes in
+# some detail the purpose of the project during the installation. Not all
+# CPack generators uses this file.
#
-# #variable
+# .. variable:: CPACK_RESOURCE_FILE_WELCOME
#
-# ::
+# Welcome file to be embedded in the installer. It welcomes users to this
+# installer. Typically used in the graphical installers on Windows and Mac
+# OS X.
#
-# CPACK_MONOLITHIC_INSTALL - Disables the component-based
-# installation mechanism. When set the component specification is ignored
-# and all installed items are put in a single "MONOLITHIC" package.
-# Some CPack generators do monolithic packaging by default and
-# may be asked to do component packaging by setting
-# CPACK_<GENNAME>_COMPONENT_INSTALL to 1/TRUE.
+# .. variable:: CPACK_MONOLITHIC_INSTALL
#
-# #end
+# Disables the component-based installation mechanism. When set the
+# component specification is ignored and all installed items are put in a
+# single "MONOLITHIC" package. Some CPack generators do monolithic
+# packaging by default and may be asked to do component packaging by
+# setting CPACK_<GENNAME>_COMPONENT_INSTALL to 1/TRUE.
#
-# #variable
+# .. variable:: CPACK_GENERATOR
#
-# ::
+# List of CPack generators to use. If not specified, CPack will create a
+# set of options CPACK_BINARY_<GENNAME> (e.g., CPACK_BINARY_NSIS) allowing
+# the user to enable/disable individual generators. This variable may be
+# used on the command line as well as in::
#
-# CPACK_GENERATOR - List of CPack generators to use. If not
-# specified, CPack will create a set of options CPACK_BINARY_<GENNAME> (e.g.,
-# CPACK_BINARY_NSIS) allowing the user to enable/disable individual
-# generators. This variable may be used on the command line
-# as well as in:
+# cpack -D CPACK_GENERATOR="ZIP;TGZ" /path/to/build/tree
#
+# .. variable:: CPACK_OUTPUT_CONFIG_FILE
#
+# The name of the CPack binary configuration file. This file is the CPack
+# configuration generated by the CPack module for binary
+# installers. Defaults to CPackConfig.cmake.
#
-# ::
+# .. variable:: CPACK_PACKAGE_EXECUTABLES
#
-# cpack -D CPACK_GENERATOR="ZIP;TGZ" /path/to/build/tree
+# Lists each of the executables and associated text label to be used to
+# create Start Menu shortcuts. For example, setting this to the list
+# ccmake;CMake will create a shortcut named "CMake" that will execute the
+# installed executable ccmake. Not all CPack generators use it (at least
+# NSIS and OSXX11 do).
#
-# #end
+# .. variable:: CPACK_STRIP_FILES
#
-# #variable
-#
-# ::
-#
-# CPACK_OUTPUT_CONFIG_FILE - The name of the CPack binary configuration
-# file. This file is the CPack configuration generated by the CPack module
-# for binary installers. Defaults to CPackConfig.cmake.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_EXECUTABLES - Lists each of the executables and associated
-# text label to be used to create Start Menu shortcuts. For example,
-# setting this to the list ccmake;CMake will
-# create a shortcut named "CMake" that will execute the installed
-# executable ccmake. Not all CPack generators use it (at least NSIS and
-# OSXX11 do).
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_STRIP_FILES - List of files to be stripped. Starting with
-# CMake 2.6.0 CPACK_STRIP_FILES will be a boolean variable which
-# enables stripping of all files (a list of files evaluates to TRUE
-# in CMake, so this change is compatible).
-#
-# #end
+# List of files to be stripped. Starting with CMake 2.6.0 CPACK_STRIP_FILES
+# will be a boolean variable which enables stripping of all files (a list
+# of files evaluates to TRUE in CMake, so this change is compatible).
#
# The following CPack variables are specific to source packages, and
# will not affect binary packages:
#
-# #variable
-#
-# ::
-#
-# CPACK_SOURCE_PACKAGE_FILE_NAME - The name of the source package. For
-# example cmake-2.6.1.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_SOURCE_STRIP_FILES - List of files in the source tree that
-# will be stripped. Starting with CMake 2.6.0
-# CPACK_SOURCE_STRIP_FILES will be a boolean variable which enables
-# stripping of all files (a list of files evaluates to TRUE in CMake,
-# so this change is compatible).
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_SOURCE_GENERATOR - List of generators used for the source
-# packages. As with CPACK_GENERATOR, if this is not specified then
-# CPack will create a set of options (e.g., CPACK_SOURCE_ZIP)
-# allowing users to select which packages will be generated.
+# .. variable:: CPACK_SOURCE_PACKAGE_FILE_NAME
#
-# #end
+# The name of the source package. For example cmake-2.6.1.
#
-# #variable
+# .. variable:: CPACK_SOURCE_STRIP_FILES
#
-# ::
+# List of files in the source tree that will be stripped. Starting with
+# CMake 2.6.0 CPACK_SOURCE_STRIP_FILES will be a boolean variable which
+# enables stripping of all files (a list of files evaluates to TRUE in
+# CMake, so this change is compatible).
#
-# CPACK_SOURCE_OUTPUT_CONFIG_FILE - The name of the CPack source
-# configuration file. This file is the CPack configuration generated by the
-# CPack module for source installers. Defaults to CPackSourceConfig.cmake.
+# .. variable:: CPACK_SOURCE_GENERATOR
#
-# #end
+# List of generators used for the source packages. As with CPACK_GENERATOR,
+# if this is not specified then CPack will create a set of options (e.g.,
+# CPACK_SOURCE_ZIP) allowing users to select which packages will be
+# generated.
#
-# #variable
+# .. variable:: CPACK_SOURCE_OUTPUT_CONFIG_FILE
#
-# ::
+# The name of the CPack source configuration file. This file is the CPack
+# configuration generated by the CPack module for source
+# installers. Defaults to CPackSourceConfig.cmake.
#
-# CPACK_SOURCE_IGNORE_FILES - Pattern of files in the source tree
-# that won't be packaged when building a source package. This is a
-# list of regular expression patterns (that must be properly escaped),
-# e.g., /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.*
+# .. variable:: CPACK_SOURCE_IGNORE_FILES
#
-# #end
+# Pattern of files in the source tree that won't be packaged when building
+# a source package. This is a list of regular expression patterns (that
+# must be properly escaped), e.g.,
+# /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.*
#
# The following variables are for advanced uses of CPack:
#
-# #variable
+# .. variable:: CPACK_CMAKE_GENERATOR
#
-# ::
+# What CMake generator should be used if the project is CMake
+# project. Defaults to the value of CMAKE_GENERATOR few users will want to
+# change this setting.
#
-# CPACK_CMAKE_GENERATOR - What CMake generator should be used if the
-# project is CMake project. Defaults to the value of CMAKE_GENERATOR
-# few users will want to change this setting.
+# .. variable:: CPACK_INSTALL_CMAKE_PROJECTS
#
-# #end
+# List of four values that specify what project to install. The four values
+# are: Build directory, Project Name, Project Component, Directory. If
+# omitted, CPack will build an installer that installers everything.
#
-# #variable
+# .. variable:: CPACK_SYSTEM_NAME
#
-# ::
+# System name, defaults to the value of ${CMAKE_SYSTEM_NAME}.
#
-# CPACK_INSTALL_CMAKE_PROJECTS - List of four values that specify
-# what project to install. The four values are: Build directory,
-# Project Name, Project Component, Directory. If omitted, CPack will
-# build an installer that installers everything.
+# .. variable:: CPACK_PACKAGE_VERSION
#
-# #end
+# Package full version, used internally. By default, this is built from
+# CPACK_PACKAGE_VERSION_MAJOR, CPACK_PACKAGE_VERSION_MINOR, and
+# CPACK_PACKAGE_VERSION_PATCH.
#
-# #variable
+# .. variable:: CPACK_TOPLEVEL_TAG
#
-# ::
+# Directory for the installed files.
#
-# CPACK_SYSTEM_NAME - System name, defaults to the value of
-# ${CMAKE_SYSTEM_NAME}.
+# .. variable:: CPACK_INSTALL_COMMANDS
#
-# #end
+# Extra commands to install components.
#
-# #variable
+# .. variable:: CPACK_INSTALLED_DIRECTORIES
#
-# ::
+# Extra directories to install.
#
-# CPACK_PACKAGE_VERSION - Package full version, used internally. By
-# default, this is built from CPACK_PACKAGE_VERSION_MAJOR,
-# CPACK_PACKAGE_VERSION_MINOR, and CPACK_PACKAGE_VERSION_PATCH.
+# .. variable:: CPACK_PACKAGE_INSTALL_REGISTRY_KEY
#
-# #end
+# Registry key used when installing this project. This is only used by
+# installer for Windows. The default value is based on the installation
+# directory.
#
-# #variable
+# .. variable:: CPACK_CREATE_DESKTOP_LINKS
#
-# ::
-#
-# CPACK_TOPLEVEL_TAG - Directory for the installed files.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_INSTALL_COMMANDS - Extra commands to install components.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_INSTALLED_DIRECTORIES - Extra directories to install.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when
-# installing this project. This is only used by installer for Windows.
-# The default value is based on the installation directory.
-#
-# #end #variable
-#
-# ::
-#
-# CPACK_CREATE_DESKTOP_LINKS - List of desktop links to create.
-#
-# #end
+# List of desktop links to create.
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.
@@ -560,15 +398,16 @@ macro(cpack_optional_append _list _cond _item)
endif()
endmacro()
-##variable
-# CPACK_BINARY_<GENNAME> - CPack generated options for binary generators. The
-# CPack.cmake module generates (when CPACK_GENERATOR is not set)
-# a set of CMake options (see CMake option command) which may then be used to
-# select the CPack generator(s) to be used when launching the package target.
-##end
-# Provide options to choose generators
-# we might check here if the required tools for the generates exist
-# and set the defaults according to the results
+#.rst:
+# .. variable:: CPACK_BINARY_<GENNAME>
+#
+# CPack generated options for binary generators. The CPack.cmake module
+# generates (when CPACK_GENERATOR is not set) a set of CMake options (see
+# CMake option command) which may then be used to select the CPack
+# generator(s) to be used when launching the package target.
+#
+# Provide options to choose generators we might check here if the required
+# tools for the generates exist and set the defaults according to the results
if(NOT CPACK_GENERATOR)
if(UNIX)
if(CYGWIN)
diff --git a/Modules/CPackBundle.cmake b/Modules/CPackBundle.cmake
index 00c5fc2..d8293c0 100644
--- a/Modules/CPackBundle.cmake
+++ b/Modules/CPackBundle.cmake
@@ -4,51 +4,35 @@
#
# CPack Bundle generator (Mac OS X) specific options
#
-# #section Variables specific to CPack Bundle generator #end #module
+# Variables specific to CPack Bundle generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
# Installers built on Mac OS X using the Bundle generator use the
# aforementioned DragNDrop (CPACK_DMG_xxx) variables, plus the following
-# Bundle-specific parameters (CPACK_BUNDLE_xxx). #end
+# Bundle-specific parameters (CPACK_BUNDLE_xxx).
#
-# #variable
+# .. variable:: CPACK_BUNDLE_NAME
#
-# ::
+# The name of the generated bundle. This appears in the OSX finder as the
+# bundle name. Required.
#
-# CPACK_BUNDLE_NAME - The name of the generated bundle. This
-# appears in the OSX finder as the bundle name. Required.
+# .. variable:: CPACK_BUNDLE_PLIST
#
-# #end
+# Path to an OSX plist file that will be used for the generated bundle. This
+# assumes that the caller has generated or specified their own Info.plist
+# file. Required.
#
-# #variable
+# .. variable:: CPACK_BUNDLE_ICON
#
-# ::
+# Path to an OSX icon file that will be used as the icon for the generated
+# bundle. This is the icon that appears in the OSX finder for the bundle, and
+# in the OSX dock when the bundle is opened. Required.
#
-# CPACK_BUNDLE_PLIST - Path to an OSX plist file that will be used
-# for the generated bundle. This assumes that the caller has generated
-# or specified their own Info.plist file. Required.
+# .. variable:: CPACK_BUNDLE_STARTUP_COMMAND
#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_BUNDLE_ICON - Path to an OSX icon file that will be used as
-# the icon for the generated bundle. This is the icon that appears in the
-# OSX finder for the bundle, and in the OSX dock when the bundle is opened.
-# Required.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_BUNDLE_STARTUP_COMMAND - Path to a startup script. This is a path to
-# an executable or script that will be run whenever an end-user double-clicks
-# the generated bundle in the OSX Finder. Optional.
-#
-# #end
+# Path to a startup script. This is a path to an executable or script that
+# will be run whenever an end-user double-clicks the generated bundle in the
+# OSX Finder. Optional.
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.
diff --git a/Modules/CPackComponent.cmake b/Modules/CPackComponent.cmake
index 4674a7b..a55a01e 100644
--- a/Modules/CPackComponent.cmake
+++ b/Modules/CPackComponent.cmake
@@ -4,7 +4,8 @@
#
# Build binary and source package installers
#
-# #section Variables concerning CPack Components #end #module
+# Variables concerning CPack Components
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
# The CPackComponent module is the module which handles the component
# part of CPack. See CPack module for general information about CPack.
@@ -23,84 +24,64 @@
# of components to install during the install process. Installation
# components are identified by the COMPONENT argument of CMake's INSTALL
# commands, and should be further described by the following CPack
-# commands: #end
+# commands:
#
-# #variable
+# .. variable:: CPACK_COMPONENTS_ALL
#
-# ::
-#
-# CPACK_COMPONENTS_ALL - The list of component to install.
-#
-#
-#
-# The default value of this variable is computed by CPack and contains
-# all components defined by the project. The user may set it to only
-# include the specified components. #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_<GENNAME>_COMPONENT_INSTALL - Enable/Disable component install for
-# CPack generator <GENNAME>.
-#
-#
-#
-# Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a
-# legacy default behavior. e.g. RPM builds monolithic whereas NSIS
-# builds component. One can change the default behavior by setting this
-# variable to 0/1 or OFF/ON. #end #variable
-#
-# ::
-#
-# CPACK_COMPONENTS_GROUPING - Specify how components are grouped for multi-package
-# component-aware CPack generators.
+# The list of component to install.
#
+# The default value of this variable is computed by CPack and contains all
+# components defined by the project. The user may set it to only include the
+# specified components.
#
+# .. variable:: CPACK_<GENNAME>_COMPONENT_INSTALL
#
-# Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates
-# several packages files when asked for component packaging. They group
-# the component differently depending on the value of this variable:
+# Enable/Disable component install for CPack generator <GENNAME>.
#
-# ::
+# Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a legacy
+# default behavior. e.g. RPM builds monolithic whereas NSIS builds
+# component. One can change the default behavior by setting this variable to
+# 0/1 or OFF/ON.
#
-# - ONE_PER_GROUP (default): creates one package file per component group
-# - ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component
-# - IGNORE : creates one package per component, i.e. IGNORE component group
+# .. variable:: CPACK_COMPONENTS_GROUPING
#
-# One can specify different grouping for different CPack generator by
-# using a CPACK_PROJECT_CONFIG_FILE. #end #variable
+# Specify how components are grouped for multi-package component-aware CPack
+# generators.
#
-# ::
+# Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates
+# several packages files when asked for component packaging. They group
+# the component differently depending on the value of this variable:
#
-# CPACK_COMPONENT_<compName>_DISPLAY_NAME - The name to be displayed for a component.
+# * ONE_PER_GROUP (default): creates one package file per component group
+# * ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component
+# * IGNORE : creates one package per component, i.e. IGNORE component group
#
-# #end #variable
+# One can specify different grouping for different CPack generator by
+# using a CPACK_PROJECT_CONFIG_FILE.
#
-# ::
+# .. variable:: CPACK_COMPONENT_<compName>_DISPLAY_NAME
#
-# CPACK_COMPONENT_<compName>_DESCRIPTION - The description of a component.
+# The name to be displayed for a component.
#
-# #end #variable
+# .. variable:: CPACK_COMPONENT_<compName>_DESCRIPTION
#
-# ::
+# The description of a component.
#
-# CPACK_COMPONENT_<compName>_GROUP - The group of a component.
+# .. variable:: CPACK_COMPONENT_<compName>_GROUP
#
-# #end #variable
+# The group of a component.
#
-# ::
+# .. variable:: CPACK_COMPONENT_<compName>_DEPENDS
#
-# CPACK_COMPONENT_<compName>_DEPENDS - The dependencies (list of components)
-# on which this component depends.
+# The dependencies (list of components) on which this component depends.
#
-# #end #variable
+# .. variable:: CPACK_COMPONENT_<compName>_REQUIRED
#
-# ::
+# True is this component is required.
#
-# CPACK_COMPONENT_<compName>_REQUIRED - True is this component is required.
+# .. command:: cpack_add_component
#
-# #end #macro cpack_add_component - Describes a CPack installation
+# Describes a CPack installation
# component named by the COMPONENT argument to a CMake INSTALL command.
#
# ::
@@ -170,10 +151,10 @@
# be used for downloaded components. If not supplied, CPack will create
# a file with some name based on CPACK_PACKAGE_FILE_NAME and the name of
# the component. See cpack_configure_downloads for more information.
-# #end
#
-# #macro cpack_add_component_group - Describes a group of related CPack
-# installation components.
+# .. command:: cpack_add_component_group
+#
+# Describes a group of related CPack installation components.
#
# ::
#
@@ -217,9 +198,11 @@
# single entry.
#
# BOLD_TITLE indicates that the group title should appear in bold, to
-# call the user's attention to the group. #end
+# call the user's attention to the group.
+#
+# .. command:: cpack_add_install_type
#
-# #macro cpack_add_install_type - Add a new installation type containing
+# Add a new installation type containing
# a set of predefined component selections to the graphical installer.
#
# ::
@@ -239,9 +222,11 @@
#
# DISPLAY_NAME is the displayed name of the install type, which will
# typically show up in a drop-down box within a graphical installer.
-# This value can be any string. #end
+# This value can be any string.
+#
+# .. command:: cpack_configure_downloads
#
-# #macro cpack_configure_downloads - Configure CPack to download
+# Configure CPack to download
# selected components on-the-fly as part of the installation process.
#
# ::
@@ -297,7 +282,7 @@
# that can be called from Windows' Add/Remove Programs dialog (via the
# "Modify" button) to change the set of installed components.
# NO_ADD_REMOVE turns off this behavior. This option is ignored on Mac
-# OS X. #endmacro
+# OS X.
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.
diff --git a/Modules/CPackCygwin.cmake b/Modules/CPackCygwin.cmake
index f3eb076..abfc1f6 100644
--- a/Modules/CPackCygwin.cmake
+++ b/Modules/CPackCygwin.cmake
@@ -4,32 +4,24 @@
#
# Cygwin CPack generator (Cygwin).
#
-# #section Variables specific to CPack Cygwin generator #end #module The
-# following variable is specific to installers build on and/or for
-# Cygwin: #end
-#
-# #variable
-#
-# ::
+# Variables specific to CPack Cygwin generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
-# CPACK_CYGWIN_PATCH_NUMBER - The Cygwin patch number.
-# FIXME: This documentation is incomplete.
-#
-# #end #variable
+# The
+# following variable is specific to installers build on and/or for
+# Cygwin:
#
-# ::
+# .. variable:: CPACK_CYGWIN_PATCH_NUMBER
#
-# CPACK_CYGWIN_PATCH_FILE - The Cygwin patch file.
-# FIXME: This documentation is incomplete.
+# The Cygwin patch number. FIXME: This documentation is incomplete.
#
-# #end #variable
+# .. variable:: CPACK_CYGWIN_PATCH_FILE
#
-# ::
+# The Cygwin patch file. FIXME: This documentation is incomplete.
#
-# CPACK_CYGWIN_BUILD_SCRIPT - The Cygwin build script.
-# FIXME: This documentation is incomplete.
+# .. variable:: CPACK_CYGWIN_BUILD_SCRIPT
#
-# #end
+# The Cygwin build script. FIXME: This documentation is incomplete.
#=============================================================================
# Copyright 2006-2012 Kitware, Inc.
diff --git a/Modules/CPackDMG.cmake b/Modules/CPackDMG.cmake
index 2f5eea4..b7a6ba5 100644
--- a/Modules/CPackDMG.cmake
+++ b/Modules/CPackDMG.cmake
@@ -4,87 +4,56 @@
#
# DragNDrop CPack generator (Mac OS X).
#
-# #section Variables specific to CPack DragNDrop generator #end #module
-# The following variables are specific to the DragNDrop installers built
-# on Mac OS X: #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_DMG_VOLUME_NAME - The volume name of the generated disk
-# image. Defaults to CPACK_PACKAGE_FILE_NAME.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_DMG_FORMAT - The disk image format. Common values are UDRO
-# (UDIF read-only), UDZO (UDIF zlib-compressed) or UDBZ (UDIF
-# bzip2-compressed). Refer to hdiutil(1) for more information on
-# other available formats.
+# Variables specific to CPack DragNDrop generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_DMG_DS_STORE - Path to a custom DS_Store file. This .DS_Store
-# file e.g. can be used to specify the Finder window
-# position/geometry and layout (such as hidden toolbars, placement of the
-# icons etc.). This file has to be generated by the Finder (either manually or
-# through OSA-script) using a normal folder from which the .DS_Store
-# file can then be extracted.
-#
-# #end
-#
-# #variable
-#
-# ::
+# The following variables are specific to the DragNDrop installers built
+# on Mac OS X:
#
-# CPACK_DMG_BACKGROUND_IMAGE - Path to a background image file. This
-# file will be used as the background for the Finder Window when the disk
-# image is opened. By default no background image is set. The background
-# image is applied after applying the custom .DS_Store file.
+# .. variable:: CPACK_DMG_VOLUME_NAME
#
-# #end
+# The volume name of the generated disk image. Defaults to
+# CPACK_PACKAGE_FILE_NAME.
#
-# #variable
+# .. variable:: CPACK_DMG_FORMAT
#
-# ::
+# The disk image format. Common values are UDRO (UDIF read-only), UDZO (UDIF
+# zlib-compressed) or UDBZ (UDIF bzip2-compressed). Refer to hdiutil(1) for
+# more information on other available formats.
#
-# CPACK_COMMAND_HDIUTIL - Path to the hdiutil(1) command used to
-# operate on disk image files on Mac OS X. This variable can be used
-# to override the automatically detected command (or specify its
-# location if the auto-detection fails to find it.)
+# .. variable:: CPACK_DMG_DS_STORE
#
-# #end
+# Path to a custom DS_Store file. This .DS_Store file e.g. can be used to
+# specify the Finder window position/geometry and layout (such as hidden
+# toolbars, placement of the icons etc.). This file has to be generated by
+# the Finder (either manually or through OSA-script) using a normal folder
+# from which the .DS_Store file can then be extracted.
#
-# #variable
+# .. variable:: CPACK_DMG_BACKGROUND_IMAGE
#
-# ::
+# Path to a background image file. This file will be used as the background
+# for the Finder Window when the disk image is opened. By default no
+# background image is set. The background image is applied after applying the
+# custom .DS_Store file.
#
-# CPACK_COMMAND_SETFILE - Path to the SetFile(1) command used to set
-# extended attributes on files and directories on Mac OS X. This
-# variable can be used to override the automatically detected
-# command (or specify its location if the auto-detection fails to
-# find it.)
+# .. variable:: CPACK_COMMAND_HDIUTIL
#
-# #end
+# Path to the hdiutil(1) command used to operate on disk image files on Mac
+# OS X. This variable can be used to override the automatically detected
+# command (or specify its location if the auto-detection fails to find it.)
#
-# #variable
+# .. variable:: CPACK_COMMAND_SETFILE
#
-# ::
+# Path to the SetFile(1) command used to set extended attributes on files and
+# directories on Mac OS X. This variable can be used to override the
+# automatically detected command (or specify its location if the
+# auto-detection fails to find it.)
#
-# CPACK_COMMAND_REZ - Path to the Rez(1) command used to compile
-# resources on Mac OS X. This variable can be used to override the
-# automatically detected command (or specify its location if the
-# auto-detection fails to find it.)
+# .. variable:: CPACK_COMMAND_REZ
#
-# #end
+# Path to the Rez(1) command used to compile resources on Mac OS X. This
+# variable can be used to override the automatically detected command (or
+# specify its location if the auto-detection fails to find it.)
#=============================================================================
# Copyright 2006-2012 Kitware, Inc.
diff --git a/Modules/CPackDeb.cmake b/Modules/CPackDeb.cmake
index 9194dc6..c79ef06 100644
--- a/Modules/CPackDeb.cmake
+++ b/Modules/CPackDeb.cmake
@@ -4,8 +4,10 @@
#
# The builtin (binary) CPack Deb generator (Unix only)
#
-# #section Variables specific to CPack Debian (DEB) generator #end
-# #module CPackDeb may be used to create Deb package using CPack.
+# Variables specific to CPack Debian (DEB) generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#
+# CPackDeb may be used to create Deb package using CPack.
# CPackDeb is a CPack generator thus it uses the CPACK_XXX variables
# used by CPack : http://www.cmake.org/Wiki/CMake:CPackConfiguration.
# CPackDeb generator should work on any linux host but it will produce
@@ -14,203 +16,179 @@
#
# CPackDeb has specific features which are controlled by the specifics
# CPACK_DEBIAN_XXX variables.You'll find a detailed usage on the wiki:
-#
-# ::
-#
-# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#DEB_.28UNIX_only.29
+# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#DEB_.28UNIX_only.29
#
# However as a handy reminder here comes the list of specific variables:
-# #end
#
-# #variable CPACK_DEBIAN_PACKAGE_NAME
+# .. variable:: CPACK_DEBIAN_PACKAGE_NAME
#
-# ::
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_NAME (lower case)
#
-# Mandatory : YES
-# Default : CPACK_PACKAGE_NAME (lower case)
-# The debian package summary
+# The debian package summary
#
-# #end #variable CPACK_DEBIAN_PACKAGE_VERSION
+# .. variable:: CPACK_DEBIAN_PACKAGE_VERSION
#
-# ::
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_VERSION
#
-# Mandatory : YES
-# Default : CPACK_PACKAGE_VERSION
-# The debian package version
+# The debian package version
#
-# #end #variable CPACK_DEBIAN_PACKAGE_ARCHITECTURE
+# .. variable:: CPACK_DEBIAN_PACKAGE_ARCHITECTURE
#
-# ::
+# * Mandatory : YES
+# * Default : Output of dpkg --print-architecture (or i386 if dpkg is not found)
#
-# Mandatory : YES
-# Default : Output of dpkg --print-architecture (or i386 if dpkg is not found)
-# The debian package architecture
+# The debian package architecture
#
-# #end #variable CPACK_DEBIAN_PACKAGE_DEPENDS
+# .. variable:: CPACK_DEBIAN_PACKAGE_DEPENDS
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# May be used to set deb dependencies.
+# May be used to set deb dependencies.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_MAINTAINER
+# .. variable:: CPACK_DEBIAN_PACKAGE_MAINTAINER
#
-# ::
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_CONTACT
#
-# Mandatory : YES
-# Default : CPACK_PACKAGE_CONTACT
-# The debian package maintainer
+# The debian package maintainer
#
-# #end #variable CPACK_DEBIAN_PACKAGE_DESCRIPTION
+# .. variable:: CPACK_DEBIAN_PACKAGE_DESCRIPTION
#
-# ::
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
#
-# Mandatory : YES
-# Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
-# The debian package description
+# The debian package description
#
-# #end #variable CPACK_DEBIAN_PACKAGE_SECTION
+# .. variable:: CPACK_DEBIAN_PACKAGE_SECTION
#
-# ::
+# * Mandatory : YES
+# * Default : 'devel'
#
-# Mandatory : YES
-# Default : 'devel'
-# The debian package section
+# The debian package section
#
-# #end #variable CPACK_DEBIAN_PACKAGE_PRIORITY
+# .. variable:: CPACK_DEBIAN_PACKAGE_PRIORITY
#
-# ::
+# * Mandatory : YES
+# * Default : 'optional'
#
-# Mandatory : YES
-# Default : 'optional'
-# The debian package priority
+# The debian package priority
#
-# #end #variable CPACK_DEBIAN_PACKAGE_HOMEPAGE
+# .. variable:: CPACK_DEBIAN_PACKAGE_HOMEPAGE
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# The URL of the web site for this package, preferably (when applicable) the
-# site from which the original source can be obtained and any additional
-# upstream documentation or information may be found.
-# The content of this field is a simple URL without any surrounding
-# characters such as <>.
+# The URL of the web site for this package, preferably (when applicable) the
+# site from which the original source can be obtained and any additional
+# upstream documentation or information may be found.
+# The content of this field is a simple URL without any surrounding
+# characters such as <>.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_SHLIBDEPS
+# .. variable:: CPACK_DEBIAN_PACKAGE_SHLIBDEPS
#
-# ::
+# * Mandatory : NO
+# * Default : OFF
#
-# Mandatory : NO
-# Default : OFF
-# May be set to ON in order to use dpkg-shlibdeps to generate
-# better package dependency list.
-# You may need set CMAKE_INSTALL_RPATH toi appropriate value
-# if you use this feature, because if you don't dpkg-shlibdeps
-# may fail to find your own shared libs.
-# See http://www.cmake.org/Wiki/CMake_RPATH_handling.
+# May be set to ON in order to use dpkg-shlibdeps to generate
+# better package dependency list.
+# You may need set CMAKE_INSTALL_RPATH toi appropriate value
+# if you use this feature, because if you don't dpkg-shlibdeps
+# may fail to find your own shared libs.
+# See http://www.cmake.org/Wiki/CMake_RPATH_handling.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_DEBUG
+# .. variable:: CPACK_DEBIAN_PACKAGE_DEBUG
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# May be set when invoking cpack in order to trace debug information
-# during CPackDeb run.
+# May be set when invoking cpack in order to trace debug information
+# during CPackDeb run.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_PREDEPENDS
+# .. variable:: CPACK_DEBIAN_PACKAGE_PREDEPENDS
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# This field is like Depends, except that it also forces dpkg to complete installation of
-# the packages named before even starting the installation of the package which declares
-# the pre-dependency.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# This field is like Depends, except that it also forces dpkg to complete installation of
+# the packages named before even starting the installation of the package which declares
+# the pre-dependency.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_ENHANCES
+# .. variable:: CPACK_DEBIAN_PACKAGE_ENHANCES
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# This field is similar to Suggests but works in the opposite direction.
-# It is used to declare that a package can enhance the functionality of another package.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# This field is similar to Suggests but works in the opposite direction.
+# It is used to declare that a package can enhance the functionality of another package.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_BREAKS
+# .. variable:: CPACK_DEBIAN_PACKAGE_BREAKS
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# When one binary package declares that it breaks another, dpkg will refuse to allow the
-# package which declares Breaks be installed unless the broken package is deconfigured first,
-# and it will refuse to allow the broken package to be reconfigured.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# When one binary package declares that it breaks another, dpkg will refuse to allow the
+# package which declares Breaks be installed unless the broken package is deconfigured first,
+# and it will refuse to allow the broken package to be reconfigured.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_CONFLICTS
+# .. variable:: CPACK_DEBIAN_PACKAGE_CONFLICTS
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# When one binary package declares a conflict with another using a Conflicts field,
-# dpkg will refuse to allow them to be installed on the system at the same time.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# When one binary package declares a conflict with another using a Conflicts field,
+# dpkg will refuse to allow them to be installed on the system at the same time.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_PROVIDES
+# .. variable:: CPACK_DEBIAN_PACKAGE_PROVIDES
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# A virtual package is one which appears in the Provides control field of another package.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# A virtual package is one which appears in the Provides control field of another package.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_REPLACES
+# .. variable:: CPACK_DEBIAN_PACKAGE_REPLACES
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# Packages can declare in their control file that they should overwrite
-# files in certain other packages, or completely replace other packages.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# Packages can declare in their control file that they should overwrite
+# files in certain other packages, or completely replace other packages.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_RECOMMENDS
+# .. variable:: CPACK_DEBIAN_PACKAGE_RECOMMENDS
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# Allows packages to declare a strong, but not absolute, dependency on other packages.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# Allows packages to declare a strong, but not absolute, dependency on other packages.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_SUGGESTS
+# .. variable:: CPACK_DEBIAN_PACKAGE_SUGGESTS
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
-# Allows packages to declare a suggested package install grouping.
+# see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
+# Allows packages to declare a suggested package install grouping.
#
-# #end #variable CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
+# .. variable:: CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# Mandatory : NO
-# Default : -
-# This variable allow advanced user to add custom script to the control.tar.gz
-# Typical usage is for conffiles, postinst, postrm, prerm.
-# Usage: set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
-# "${CMAKE_CURRENT_SOURCE_DIR/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm")
+# This variable allow advanced user to add custom script to the
+# control.tar.gz Typical usage is for conffiles, postinst, postrm, prerm.
+# Usage::
#
-# #end
+# set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
+# "${CMAKE_CURRENT_SOURCE_DIR/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm")
#=============================================================================
diff --git a/Modules/CPackNSIS.cmake b/Modules/CPackNSIS.cmake
index 717bf92..9d23ec0 100644
--- a/Modules/CPackNSIS.cmake
+++ b/Modules/CPackNSIS.cmake
@@ -4,216 +4,119 @@
#
# CPack NSIS generator specific options
#
-# #section Variables specific to CPack NSIS generator #end #module
+# Variables specific to CPack NSIS generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
# The following variables are specific to the graphical installers built
-# on Windows using the Nullsoft Installation System. #end
+# on Windows using the Nullsoft Installation System.
#
-# #variable
+# .. variable:: CPACK_NSIS_INSTALL_ROOT
#
-# ::
+# The default installation directory presented to the end user by the NSIS
+# installer is under this root dir. The full directory presented to the end
+# user is: ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
#
-# CPACK_NSIS_INSTALL_ROOT - The default installation directory presented
-# to the end user by the NSIS installer is under this root dir. The full
-# directory presented to the end user is:
-# ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
+# .. variable:: CPACK_NSIS_MUI_ICON
#
-# #end
+# An icon filename. The name of a ``*.ico`` file used as the main icon for the
+# generated install program.
#
-# #variable
+# .. variable:: CPACK_NSIS_MUI_UNIICON
#
-# ::
+# An icon filename. The name of a ``*.ico`` file used as the main icon for the
+# generated uninstall program.
#
-# CPACK_NSIS_MUI_ICON - An icon filename.
-# The name of a *.ico file used as the main icon for the generated
-# install program.
+# .. variable:: CPACK_NSIS_INSTALLER_MUI_ICON_CODE
#
-# #end
+# undocumented.
#
-# #variable
+# .. variable:: CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
#
-# ::
+# Extra NSIS commands that will be added to the beginning of the install
+# Section, before your install tree is available on the target system.
#
-# CPACK_NSIS_MUI_UNIICON - An icon filename.
-# The name of a *.ico file used as the main icon for the generated
-# uninstall program.
+# .. variable:: CPACK_NSIS_EXTRA_INSTALL_COMMANDS
#
-# #end
+# Extra NSIS commands that will be added to the end of the install Section,
+# after your install tree is available on the target system.
#
-# #variable
+# .. variable:: CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
#
-# ::
+# Extra NSIS commands that will be added to the uninstall Section, before
+# your install tree is removed from the target system.
#
-# CPACK_NSIS_INSTALLER_MUI_ICON_CODE - undocumented.
+# .. variable:: CPACK_NSIS_COMPRESSOR
#
-# #end
+# The arguments that will be passed to the NSIS SetCompressor command.
#
-# #variable
+# .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
#
-# ::
+# Ask about uninstalling previous versions first. If this is set to "ON",
+# then an installer will look for previous installed versions and if one is
+# found, ask the user whether to uninstall it before proceeding with the
+# install.
#
-# CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS - Extra NSIS commands that
-# will be added to the beginning of the install Section, before your
-# install tree is available on the target system.
+# .. variable:: CPACK_NSIS_MODIFY_PATH
#
-# #end
+# Modify PATH toggle. If this is set to "ON", then an extra page will appear
+# in the installer that will allow the user to choose whether the program
+# directory should be added to the system PATH variable.
#
-# #variable
+# .. variable:: CPACK_NSIS_DISPLAY_NAME
#
-# ::
+# The display name string that appears in the Windows Add/Remove Program
+# control panel
#
-# CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that
-# will be added to the end of the install Section, after your
-# install tree is available on the target system.
+# .. variable:: CPACK_NSIS_PACKAGE_NAME
#
-# #end
+# The title displayed at the top of the installer.
#
-# #variable
+# .. variable:: CPACK_NSIS_INSTALLED_ICON_NAME
#
-# ::
+# A path to the executable that contains the installer icon.
#
-# CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will
-# be added to the uninstall Section, before your install tree is
-# removed from the target system.
+# .. variable:: CPACK_NSIS_HELP_LINK
#
-# #end
+# URL to a web site providing assistance in installing your application.
#
-# #variable
+# .. variable:: CPACK_NSIS_URL_INFO_ABOUT
#
-# ::
+# URL to a web site providing more information about your application.
#
-# CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the
-# NSIS SetCompressor command.
+# .. variable:: CPACK_NSIS_CONTACT
#
-# #end
+# Contact information for questions and comments about the installation
+# process.
#
-# #variable
+# .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
#
-# ::
+# Additional NSIS commands for creating start menu shortcuts.
#
-# CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL - Ask about uninstalling
-# previous versions first.
-# If this is set to "ON", then an installer will look for previous
-# installed versions and if one is found, ask the user whether to
-# uninstall it before proceeding with the install.
+# .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
#
-# #end
+# Additional NSIS commands to uninstall start menu shortcuts.
#
-# #variable
+# .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
#
-# ::
+# Creating NSIS start menu links assumes that they are in 'bin' unless this
+# variable is set. For example, you would set this to 'exec' if your
+# executables are in an exec directory.
#
-# CPACK_NSIS_MODIFY_PATH - Modify PATH toggle.
-# If this is set to "ON", then an extra page
-# will appear in the installer that will allow the user to choose
-# whether the program directory should be added to the system PATH
-# variable.
+# .. variable:: CPACK_NSIS_MUI_FINISHPAGE_RUN
#
-# #end
+# Specify an executable to add an option to run on the finish page of the
+# NSIS installer.
#
-# #variable
+# .. variable:: CPACK_NSIS_MENU_LINKS
#
-# ::
+# Specify links in [application] menu. This should contain a list of pair
+# "link" "link name". The link may be an URL or a path relative to
+# installation prefix. Like::
#
-# CPACK_NSIS_DISPLAY_NAME - The display name string that appears in
-# the Windows Add/Remove Program control panel
+# set(CPACK_NSIS_MENU_LINKS
+# "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help"
+# "http://www.cmake.org" "CMake Web Site")
#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_PACKAGE_NAME - The title displayed at the top of the
-# installer.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_INSTALLED_ICON_NAME - A path to the executable that
-# contains the installer icon.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_HELP_LINK - URL to a web site providing assistance in
-# installing your application.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_URL_INFO_ABOUT - URL to a web site providing more
-# information about your application.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_CONTACT - Contact information for questions and comments
-# about the installation process.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_CREATE_ICONS_EXTRA - Additional NSIS commands for
-# creating start menu shortcuts.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_DELETE_ICONS_EXTRA -Additional NSIS commands to
-# uninstall start menu shortcuts.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_EXECUTABLES_DIRECTORY - Creating NSIS start menu links
-# assumes that they are in 'bin' unless this variable is set.
-# For example, you would set this to 'exec' if your executables are
-# in an exec directory.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option
-# to run on the finish page of the NSIS installer.
-#
-# #end #variable
-#
-# ::
-#
-# CPACK_NSIS_MENU_LINKS - Specify links in [application] menu.
-# This should contain a list of pair "link" "link name". The link
-# may be an URL or a path relative to installation prefix.
-# Like:
-# set(CPACK_NSIS_MENU_LINKS
-# "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help"
-# "http://www.cmake.org" "CMake Web Site")
-#
-# #end
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.
diff --git a/Modules/CPackPackageMaker.cmake b/Modules/CPackPackageMaker.cmake
index 689d34c..4160425 100644
--- a/Modules/CPackPackageMaker.cmake
+++ b/Modules/CPackPackageMaker.cmake
@@ -4,28 +4,24 @@
#
# PackageMaker CPack generator (Mac OS X).
#
-# #section Variables specific to CPack PackageMaker generator #end
-# #module The following variable is specific to installers built on Mac
-# OS X using PackageMaker: #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_OSX_PACKAGE_VERSION - The version of Mac OS X that the
-# resulting PackageMaker archive should be compatible with. Different
-# versions of Mac OS X support different
-# features. For example, CPack can only build component-based
-# installers for Mac OS X 10.4 or newer, and can only build
-# installers that download component son-the-fly for Mac OS X 10.5
-# or newer. If left blank, this value will be set to the minimum
-# version of Mac OS X that supports the requested features. Set this
-# variable to some value (e.g., 10.4) only if you want to guarantee
-# that your installer will work on that version of Mac OS X, and
-# don't mind missing extra features available in the installer
-# shipping with later versions of Mac OS X.
-#
-# #end
+# Variables specific to CPack PackageMaker generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#
+# The following variable is specific to installers built on Mac
+# OS X using PackageMaker:
+#
+# .. variable:: CPACK_OSX_PACKAGE_VERSION
+#
+# The version of Mac OS X that the resulting PackageMaker archive should be
+# compatible with. Different versions of Mac OS X support different
+# features. For example, CPack can only build component-based installers for
+# Mac OS X 10.4 or newer, and can only build installers that download
+# component son-the-fly for Mac OS X 10.5 or newer. If left blank, this value
+# will be set to the minimum version of Mac OS X that supports the requested
+# features. Set this variable to some value (e.g., 10.4) only if you want to
+# guarantee that your installer will work on that version of Mac OS X, and
+# don't mind missing extra features available in the installer shipping with
+# later versions of Mac OS X.
#=============================================================================
# Copyright 2006-2012 Kitware, Inc.
diff --git a/Modules/CPackRPM.cmake b/Modules/CPackRPM.cmake
index f8303ab..a13a46f 100644
--- a/Modules/CPackRPM.cmake
+++ b/Modules/CPackRPM.cmake
@@ -4,7 +4,9 @@
#
# The builtin (binary) CPack RPM generator (Unix only)
#
-# #section Variables specific to CPack RPM generator #end #module
+# Variables specific to CPack RPM generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+#
# CPackRPM may be used to create RPM package using CPack. CPackRPM is a
# CPack generator thus it uses the CPACK_XXX variables used by CPack :
# http://www.cmake.org/Wiki/CMake:CPackConfiguration
@@ -25,313 +27,305 @@
# http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#RPM_.28Unix_Only.29
#
# However as a handy reminder here comes the list of specific variables:
-# #end
#
-# #variable
+# .. variable:: CPACK_RPM_PACKAGE_SUMMARY
#
-# ::
+# The RPM package summary.
#
-# CPACK_RPM_PACKAGE_SUMMARY - The RPM package summary.
-# Mandatory : YES
-# Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
#
-# #end #variable
+# .. variable:: CPACK_RPM_PACKAGE_NAME
#
-# ::
+# The RPM package name.
#
-# CPACK_RPM_PACKAGE_NAME - The RPM package name.
-# Mandatory : YES
-# Default : CPACK_PACKAGE_NAME
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_NAME
#
-# #end #variable
+# .. variable:: CPACK_RPM_PACKAGE_VERSION
#
-# ::
+# The RPM package version.
#
-# CPACK_RPM_PACKAGE_VERSION - The RPM package version.
-# Mandatory : YES
-# Default : CPACK_PACKAGE_VERSION
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_VERSION
#
-# #end #variable
+# .. variable:: CPACK_RPM_PACKAGE_ARCHITECTURE
#
-# ::
+# The RPM package architecture.
#
-# CPACK_RPM_PACKAGE_ARCHITECTURE - The RPM package architecture.
-# Mandatory : NO
-# Default : -
-# This may be set to "noarch" if you
-# know you are building a noarch package.
+# * Mandatory : NO
+# * Default : -
#
-# #end #variable
+# This may be set to "noarch" if you know you are building a noarch package.
#
-# ::
+# .. variable:: CPACK_RPM_PACKAGE_RELEASE
#
-# CPACK_RPM_PACKAGE_RELEASE - The RPM package release.
-# Mandatory : YES
-# Default : 1
-# This is the numbering of the RPM package
-# itself, i.e. the version of the packaging and not the version of the
-# content (see CPACK_RPM_PACKAGE_VERSION). One may change the default
-# value if the previous packaging was buggy and/or you want to put here
-# a fancy Linux distro specific numbering.
+# The RPM package release.
#
-# #end #variable
+# * Mandatory : YES
+# * Default : 1
#
-# ::
+# This is the numbering of the RPM package itself, i.e. the version of the
+# packaging and not the version of the content (see
+# CPACK_RPM_PACKAGE_VERSION). One may change the default value if the
+# previous packaging was buggy and/or you want to put here a fancy Linux
+# distro specific numbering.
#
-# CPACK_RPM_PACKAGE_LICENSE - The RPM package license policy.
-# Mandatory : YES
-# Default : "unknown"
+# .. variable:: CPACK_RPM_PACKAGE_LICENSE
#
-# #end #variable
+# The RPM package license policy.
#
-# ::
+# * Mandatory : YES
+# * Default : "unknown"
#
-# CPACK_RPM_PACKAGE_GROUP - The RPM package group.
-# Mandatory : YES
-# Default : "unknown"
+# .. variable:: CPACK_RPM_PACKAGE_GROUP
#
-# #end #variable
+# The RPM package group.
#
-# ::
+# * Mandatory : YES
+# * Default : "unknown"
#
-# CPACK_RPM_PACKAGE_VENDOR - The RPM package vendor.
-# Mandatory : YES
-# Default : CPACK_PACKAGE_VENDOR if set or "unknown"
+# .. variable:: CPACK_RPM_PACKAGE_VENDOR
#
-# #end #variable
+# The RPM package vendor.
#
-# ::
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_VENDOR if set or "unknown"
#
-# CPACK_RPM_PACKAGE_URL - The projects URL.
-# Mandatory : NO
-# Default : -
+# .. variable:: CPACK_RPM_PACKAGE_URL
#
-# #end #variable
+# The projects URL.
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# CPACK_RPM_PACKAGE_DESCRIPTION - RPM package description.
-# Mandatory : YES
-# Default : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package description available"
+# .. variable:: CPACK_RPM_PACKAGE_DESCRIPTION
#
-# #end #variable
+# RPM package description.
#
-# ::
+# * Mandatory : YES
+# * Default : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package
+# description available"
#
-# CPACK_RPM_COMPRESSION_TYPE - RPM compression type.
-# Mandatory : NO
-# Default : -
-# May be used to override RPM compression type to be used
-# to build the RPM. For example some Linux distribution now default
-# to lzma or xz compression whereas older cannot use such RPM.
-# Using this one can enforce compression type to be used.
-# Possible value are: lzma, xz, bzip2 and gzip.
+# .. variable:: CPACK_RPM_COMPRESSION_TYPE
#
-# #end #variable
+# RPM compression type.
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# CPACK_RPM_PACKAGE_REQUIRES - RPM spec requires field.
-# Mandatory : NO
-# Default : -
-# May be used to set RPM dependencies (requires).
-# Note that you must enclose the complete requires string between quotes,
-# for example:
-# set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8")
-# The required package list of an RPM file could be printed with
-# rpm -qp --requires file.rpm
+# May be used to override RPM compression type to be used to build the
+# RPM. For example some Linux distribution now default to lzma or xz
+# compression whereas older cannot use such RPM. Using this one can enforce
+# compression type to be used. Possible value are: lzma, xz, bzip2 and gzip.
#
-# #end #variable
+# .. variable:: CPACK_RPM_PACKAGE_REQUIRES
#
-# ::
+# RPM spec requires field.
#
-# CPACK_RPM_PACKAGE_SUGGESTS - RPM spec suggest field.
-# Mandatory : NO
-# Default : -
-# May be used to set weak RPM dependencies (suggests).
-# Note that you must enclose the complete requires string between quotes.
+# * Mandatory : NO
+# * Default : -
#
-# #end #variable
+# May be used to set RPM dependencies (requires). Note that you must enclose
+# the complete requires string between quotes, for example::
#
-# ::
+# set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8")
#
-# CPACK_RPM_PACKAGE_PROVIDES - RPM spec provides field.
-# Mandatory : NO
-# Default : -
-# May be used to set RPM dependencies (provides).
-# The provided package list of an RPM file could be printed with
-# rpm -qp --provides file.rpm
+# The required package list of an RPM file could be printed with::
#
-# #end #variable
+# rpm -qp --requires file.rpm
#
-# ::
+# .. variable:: CPACK_RPM_PACKAGE_SUGGESTS
#
-# CPACK_RPM_PACKAGE_OBSOLETES - RPM spec obsoletes field.
-# Mandatory : NO
-# Default : -
-# May be used to set RPM packages that are obsoleted by this one.
+# RPM spec suggest field.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : -
#
-# ::
+# May be used to set weak RPM dependencies (suggests). Note that you must
+# enclose the complete requires string between quotes.
#
-# CPACK_RPM_PACKAGE_RELOCATABLE - build a relocatable RPM.
-# Mandatory : NO
-# Default : CPACK_PACKAGE_RELOCATABLE
-# If this variable is set to TRUE or ON CPackRPM will try
-# to build a relocatable RPM package. A relocatable RPM may
-# be installed using rpm --prefix or --relocate in order to
-# install it at an alternate place see rpm(8).
-# Note that currently this may fail if CPACK_SET_DESTDIR is set to ON.
-# If CPACK_SET_DESTDIR is set then you will get a warning message
-# but if there is file installed with absolute path you'll get
-# unexpected behavior.
+# .. variable:: CPACK_RPM_PACKAGE_PROVIDES
#
-# #end #variable
+# RPM spec provides field.
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# CPACK_RPM_SPEC_INSTALL_POST - [deprecated].
-# Mandatory : NO
-# Default : -
-# This way of specifying post-install script is deprecated use
-# CPACK_RPM_POST_INSTALL_SCRIPT_FILE
-# May be used to set an RPM post-install command inside the spec file.
-# For example setting it to "/bin/true" may be used to prevent
-# rpmbuild to strip binaries.
+# May be used to set RPM dependencies (provides). The provided package list
+# of an RPM file could be printed with::
#
-# #end #variable
+# rpm -qp --provides file.rpm
#
-# ::
+# .. variable:: CPACK_RPM_PACKAGE_OBSOLETES
#
-# CPACK_RPM_SPEC_MORE_DEFINE - RPM extended spec definitions lines.
-# Mandatory : NO
-# Default : -
-# May be used to add any %define lines to the generated spec file.
+# RPM spec obsoletes field.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : -
#
-# ::
+# May be used to set RPM packages that are obsoleted by this one.
#
-# CPACK_RPM_PACKAGE_DEBUG - Toggle CPackRPM debug output.
-# Mandatory : NO
-# Default : -
-# May be set when invoking cpack in order to trace debug information
-# during CPack RPM run. For example you may launch CPack like this
-# cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM
+# .. variable:: CPACK_RPM_PACKAGE_RELOCATABLE
#
-# #end #variable
+# build a relocatable RPM.
#
-# ::
+# * Mandatory : NO
+# * Default : CPACK_PACKAGE_RELOCATABLE
#
-# CPACK_RPM_USER_BINARY_SPECFILE - A user provided spec file.
-# Mandatory : NO
-# Default : -
-# May be set by the user in order to specify a USER binary spec file
-# to be used by CPackRPM instead of generating the file.
-# The specified file will be processed by configure_file( @ONLY).
-# One can provide a component specific file by setting
-# CPACK_RPM_<componentName>_USER_BINARY_SPECFILE.
+# If this variable is set to TRUE or ON CPackRPM will try
+# to build a relocatable RPM package. A relocatable RPM may
+# be installed using::
#
-# #end #variable
+# rpm --prefix or --relocate
#
-# ::
+# in order to install it at an alternate place see rpm(8). Note that
+# currently this may fail if CPACK_SET_DESTDIR is set to ON. If
+# CPACK_SET_DESTDIR is set then you will get a warning message but if there
+# is file installed with absolute path you'll get unexpected behavior.
#
-# CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE - Spec file template.
-# Mandatory : NO
-# Default : -
-# If set CPack will generate a template for USER specified binary
-# spec file and stop with an error. For example launch CPack like this
-# cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM
-# The user may then use this file in order to hand-craft is own
-# binary spec file which may be used with CPACK_RPM_USER_BINARY_SPECFILE.
+# .. variable:: CPACK_RPM_SPEC_INSTALL_POST
#
-# #end #variable
+# * Mandatory : NO
+# * Default : -
+# * Deprecated: YES
#
-# ::
+# This way of specifying post-install script is deprecated, use
+# CPACK_RPM_POST_INSTALL_SCRIPT_FILE.
+# May be used to set an RPM post-install command inside the spec file.
+# For example setting it to "/bin/true" may be used to prevent
+# rpmbuild to strip binaries.
#
-# CPACK_RPM_PRE_INSTALL_SCRIPT_FILE
-# CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE
-# Mandatory : NO
-# Default : -
-# May be used to embed a pre (un)installation script in the spec file.
-# The refered script file(s) will be read and directly
-# put after the %pre or %preun section
-# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for
-# each component can be overridden with
-# CPACK_RPM_<COMPONENT>_PRE_INSTALL_SCRIPT_FILE and
-# CPACK_RPM_<COMPONENT>_PRE_UNINSTALL_SCRIPT_FILE
-# One may verify which scriptlet has been included with
-# rpm -qp --scripts package.rpm
-#
-# #end #variable
+# .. variable:: CPACK_RPM_SPEC_MORE_DEFINE
#
-# ::
+# RPM extended spec definitions lines.
#
-# CPACK_RPM_POST_INSTALL_SCRIPT_FILE
-# CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE
-# Mandatory : NO
-# Default : -
-# May be used to embed a post (un)installation script in the spec file.
-# The refered script file(s) will be read and directly
-# put after the %post or %postun section
-# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for
-# each component can be overridden with
-# CPACK_RPM_<COMPONENT>_POST_INSTALL_SCRIPT_FILE and
-# CPACK_RPM_<COMPONENT>_POST_UNINSTALL_SCRIPT_FILE
-# One may verify which scriptlet has been included with
-# rpm -qp --scripts package.rpm
-#
-# #end #variable
+# * Mandatory : NO
+# * Default : -
#
-# ::
+# May be used to add any %define lines to the generated spec file.
#
-# CPACK_RPM_USER_FILELIST
-# CPACK_RPM_<COMPONENT>_USER_FILELIST
-# Mandatory : NO
-# Default : -
-# May be used to explicitly specify %(<directive>) file line
-# in the spec file. Like %config(noreplace) or any other directive
-# that be found in the %files section. Since CPackRPM is generating
-# the list of files (and directories) the user specified files of
-# the CPACK_RPM_<COMPONENT>_USER_FILELIST list will be removed from the generated list.
+# .. variable:: CPACK_RPM_PACKAGE_DEBUG
#
-# #end #variable
+# Toggle CPackRPM debug output.
#
-# ::
+# * Mandatory : NO
+# * Default : -
#
-# CPACK_RPM_CHANGELOG_FILE - RPM changelog file.
-# Mandatory : NO
-# Default : -
-# May be used to embed a changelog in the spec file.
-# The refered file will be read and directly put after the %changelog
-# section.
+# May be set when invoking cpack in order to trace debug information
+# during CPack RPM run. For example you may launch CPack like this::
#
-# #end #variable
+# cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM
#
-# ::
+# .. variable:: CPACK_RPM_USER_BINARY_SPECFILE
#
-# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST - list of path to be excluded.
-# Mandatory : NO
-# Default : /etc /etc/init.d /usr /usr/share /usr/share/doc /usr/bin /usr/lib /usr/lib64 /usr/include
-# May be used to exclude path (directories or files) from the auto-generated
-# list of paths discovered by CPack RPM. The defaut value contains a reasonable
-# set of values if the variable is not defined by the user. If the variable
-# is defined by the user then CPackRPM will NOT any of the default path.
-# If you want to add some path to the default list then you can use
-# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION variable.
+# A user provided spec file.
#
-# #end #variable
+# * Mandatory : NO
+# * Default : -
#
-# ::
+# May be set by the user in order to specify a USER binary spec file
+# to be used by CPackRPM instead of generating the file.
+# The specified file will be processed by configure_file( @ONLY).
+# One can provide a component specific file by setting
+# CPACK_RPM_<componentName>_USER_BINARY_SPECFILE.
+#
+# .. variable:: CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE
+#
+# Spec file template.
+#
+# * Mandatory : NO
+# * Default : -
+#
+# If set CPack will generate a template for USER specified binary
+# spec file and stop with an error. For example launch CPack like this::
+#
+# cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM
+#
+# The user may then use this file in order to hand-craft is own
+# binary spec file which may be used with CPACK_RPM_USER_BINARY_SPECFILE.
+#
+# .. variable:: CPACK_RPM_PRE_INSTALL_SCRIPT_FILE
+# CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE
+#
+# * Mandatory : NO
+# * Default : -
+#
+# May be used to embed a pre (un)installation script in the spec file.
+# The refered script file(s) will be read and directly
+# put after the %pre or %preun section
+# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for
+# each component can be overridden with
+# CPACK_RPM_<COMPONENT>_PRE_INSTALL_SCRIPT_FILE and
+# CPACK_RPM_<COMPONENT>_PRE_UNINSTALL_SCRIPT_FILE.
+# One may verify which scriptlet has been included with::
+#
+# rpm -qp --scripts package.rpm
+#
+# .. variable:: CPACK_RPM_POST_INSTALL_SCRIPT_FILE
+# CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE
+#
+# * Mandatory : NO
+# * Default : -
+#
+# May be used to embed a post (un)installation script in the spec file.
+# The refered script file(s) will be read and directly
+# put after the %post or %postun section.
+# If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for
+# each component can be overridden with
+# CPACK_RPM_<COMPONENT>_POST_INSTALL_SCRIPT_FILE and
+# CPACK_RPM_<COMPONENT>_POST_UNINSTALL_SCRIPT_FILE.
+# One may verify which scriptlet has been included with::
+#
+# rpm -qp --scripts package.rpm
+#
+# .. variable:: CPACK_RPM_USER_FILELIST
+# CPACK_RPM_<COMPONENT>_USER_FILELIST
+#
+# * Mandatory : NO
+# * Default : -
+#
+# May be used to explicitly specify %(<directive>) file line
+# in the spec file. Like %config(noreplace) or any other directive
+# that be found in the %files section. Since CPackRPM is generating
+# the list of files (and directories) the user specified files of
+# the CPACK_RPM_<COMPONENT>_USER_FILELIST list will be removed from
+# the generated list.
+#
+# .. variable:: CPACK_RPM_CHANGELOG_FILE
+#
+# RPM changelog file.
+#
+# * Mandatory : NO
+# * Default : -
+#
+# May be used to embed a changelog in the spec file.
+# The refered file will be read and directly put after the %changelog
+# section.
+#
+# .. variable:: CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST
+#
+# list of path to be excluded.
+#
+# * Mandatory : NO
+# * Default : /etc /etc/init.d /usr /usr/share /usr/share/doc /usr/bin /usr/lib /usr/lib64 /usr/include
+#
+# May be used to exclude path (directories or files) from the auto-generated
+# list of paths discovered by CPack RPM. The defaut value contains a
+# reasonable set of values if the variable is not defined by the user. If the
+# variable is defined by the user then CPackRPM will NOT any of the default
+# path. If you want to add some path to the default list then you can use
+# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION variable.
+#
+# .. variable:: CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION
+#
+# additional list of path to be excluded.
#
-# CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION - additional list of path to be excluded.
-# Mandatory : NO
-# Default : -
-# May be used to add more exclude path (directories or files) from the initial
-# default list of excluded paths. See CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST.
+# * Mandatory : NO
+# * Default : -
#
-# #end
+# May be used to add more exclude path (directories or files) from the initial
+# default list of excluded paths. See CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST.
#=============================================================================
# Copyright 2007-2009 Kitware, Inc.
diff --git a/Modules/CPackWIX.cmake b/Modules/CPackWIX.cmake
index 2634f5f..7c7d924 100644
--- a/Modules/CPackWIX.cmake
+++ b/Modules/CPackWIX.cmake
@@ -4,135 +4,125 @@
#
# CPack WiX generator specific options
#
-# #section Variables specific to CPack WiX generator #end #module
+# Variables specific to CPack WiX generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
# The following variables are specific to the installers built on
-# Windows using WiX. #end #variable
+# Windows using WiX.
#
-# ::
+# .. variable:: CPACK_WIX_UPGRADE_GUID
#
-# CPACK_WIX_UPGRADE_GUID - Upgrade GUID (Product/@UpgradeCode)
+# Upgrade GUID (Product/@UpgradeCode)
#
+# Will be automatically generated unless explicitly provided.
#
+# It should be explicitly set to a constant generated gloabally unique
+# identifier (GUID) to allow your installers to replace existing
+# installations that use the same GUID.
#
-# Will be automatically generated unless explicitly provided.
+# You may for example explicitly set this variable in your
+# CMakeLists.txt to the value that has been generated per default. You
+# should not use GUIDs that you did not generate yourself or which may
+# belong to other projects.
#
-# It should be explicitly set to a constant generated gloabally unique
-# identifier (GUID) to allow your installers to replace existing
-# installations that use the same GUID.
+# A GUID shall have the following fixed length syntax::
#
-# You may for example explicitly set this variable in your
-# CMakeLists.txt to the value that has been generated per default. You
-# should not use GUIDs that you did not generate yourself or which may
-# belong to other projects.
+# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
#
-# A GUID shall have the following fixed length syntax:
-# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+# (each X represents an uppercase hexadecimal digit)
#
-# ::
+# .. variable:: CPACK_WIX_PRODUCT_GUID
#
-# (each X represents an uppercase hexadecimal digit)
+# Product GUID (Product/@Id)
#
-# #end #variable
+# Will be automatically generated unless explicitly provided.
#
-# ::
+# If explicitly provided this will set the Product Id of your installer.
#
-# CPACK_WIX_PRODUCT_GUID - Product GUID (Product/@Id)
+# The installer will abort if it detects a pre-existing installation that
+# uses the same GUID.
#
+# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID.
#
+# .. variable:: CPACK_WIX_LICENSE_RTF
#
-# Will be automatically generated unless explicitly provided.
+# RTF License File
#
-# If explicitly provided this will set the Product Id of your installer.
+# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is.
#
-# The installer will abort if it detects a pre-existing installation
-# that uses the same GUID.
+# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly
+# converted to RTF by the WiX Generator.
#
-# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID.
-# #end #variable
+# With CPACK_WIX_LICENSE_RTF you can override the license file used by the
+# WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported
+# format or the .txt -> .rtf conversion does not work as expected.
#
-# ::
+# .. variable:: CPACK_WIX_PRODUCT_ICON
#
-# CPACK_WIX_LICENSE_RTF - RTF License File
+# The Icon shown next to the program name in Add/Remove programs.
#
+# If set, this icon is used in place of the default icon.
#
+# .. variable:: CPACK_WIX_UI_BANNER
#
-# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is.
+# The bitmap will appear at the top of all installer pages other than the
+# welcome and completion dialogs.
#
-# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly
-# converted to RTF by the WiX Generator.
+# If set, this image will replace the default banner image.
#
-# With CPACK_WIX_LICENSE_RTF you can override the license file used by
-# the WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an
-# unsupported format or the .txt -> .rtf conversion does not work as
-# expected.
+# This image must be 493 by 58 pixels.
#
-# #end
+# .. variable:: CPACK_WIX_UI_DIALOG
#
-# #variable CPACK_WIX_PRODUCT_ICON - The Icon shown next to the program
-# name in Add/Remove programs.
+# Background bitmap used on the welcome and completion dialogs.
#
-# If set, this icon is used in place of the default icon.
+# If this variable is set, the installer will replace the default dialog
+# image.
#
-# #end
+# This image must be 493 by 312 pixels.
#
-# #variable CPACK_WIX_UI_BANNER - The bitmap will appear at the top of
-# all installer pages other than the welcome and completion dialogs.
+# .. variable:: CPACK_WIX_PROGRAM_MENU_FOLDER
#
-# If set, this image will replace the default banner image.
+# Start menu folder name for launcher.
#
-# This image must be 493 by 58 pixels.
+# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME
#
-# #end
+# .. variable:: CPACK_WIX_CULTURES
#
-# #variable CPACK_WIX_UI_DIALOG - Background bitmap used on the welcome
-# and completion dialogs.
+# Language(s) of the installer
#
-# If this variable is set, the installer will replace the default dialog
-# image.
+# Languages are compiled into the WixUI extension library. To use them,
+# simply provide the name of the culture. If you specify more than one
+# culture identifier in a comma or semicolon delimited list, the first one
+# that is found will be used. You can find a list of supported languages at:
+# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm
#
-# This image must be 493 by 312 pixels.
+# .. variable:: CPACK_WIX_TEMPLATE
#
-# #end
+# Template file for WiX generation
#
-# #variable CPACK_WIX_PROGRAM_MENU_FOLDER - Start menu folder name for
-# launcher.
+# If this variable is set, the specified template will be used to generate
+# the WiX wxs file. This should be used if further customization of the
+# output is required.
#
-# If this variable is not set, it will be initialized with
-# CPACK_PACKAGE_NAME
+# If this variable is not set, the default MSI template included with CMake
+# will be used.
#
-# #end #variable CPACK_WIX_CULTURES - Language(s) of the installer
+# .. variable:: CPACK_WIX_EXTRA_SOURCES
#
-# Languages are compiled into the WixUI extension library. To use them,
-# simply provide the name of the culture. If you specify more than one
-# culture identifier in a comma or semicolon delimited list, the first
-# one that is found will be used. You can find a list of supported
-# languages at:
-# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm
+# Extra WiX source files
#
-# #end #variable CPACK_WIX_TEMPLATE - Template file for WiX generation
+# This variable provides an optional list of extra WiX source files (.wxs)
+# that should be compiled and linked. The full path to source files is
+# required.
#
-# If this variable is set, the specified template will be used to
-# generate the WiX wxs file. This should be used if further
-# customization of the output is required.
+# .. variable:: CPACK_WIX_EXTRA_OBJECTS
#
-# If this variable is not set, the default MSI template included with
-# CMake will be used.
+# Extra WiX object files or libraries
#
-# #end #variable CPACK_WIX_EXTRA_SOURCES - Extra WiX source files
-#
-# This variable provides an optional list of extra WiX source files
-# (.wxs) that should be compiled and linked. The full path to source
-# files is required.
-#
-# #end #variable CPACK_WIX_EXTRA_OBJECTS - Extra WiX object files or
-# libraries
-#
-# This variable provides an optional list of extra WiX object (.wixobj)
-# and/or WiX library (.wixlib) files. The full path to objects and
-# libraries is required.
-#
-# #end
+# This variable provides an optional list of extra WiX object (.wixobj)
+# and/or WiX library (.wixlib) files. The full path to objects and libraries
+# is required.
#=============================================================================
# Copyright 2012 Kitware, Inc.