From f051814ed0e63badbfd68049354f36259dbf4b49 Mon Sep 17 00:00:00 2001 From: Kitware Robot Date: Tue, 15 Oct 2013 11:17:36 -0400 Subject: Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. --- Modules/DeployQt4.cmake | 111 +++++++++++++++++++++++++++++++----------------- 1 file changed, 71 insertions(+), 40 deletions(-) (limited to 'Modules/DeployQt4.cmake') diff --git a/Modules/DeployQt4.cmake b/Modules/DeployQt4.cmake index 5f8a9fbf37..9b31567c90 100644 --- a/Modules/DeployQt4.cmake +++ b/Modules/DeployQt4.cmake @@ -1,68 +1,99 @@ -# - Functions to help assemble a standalone Qt4 executable. -# A collection of CMake utility functions useful for deploying -# Qt4 executables. +#.rst: +# DeployQt4 +# --------- +# +# Functions to help assemble a standalone Qt4 executable. +# +# A collection of CMake utility functions useful for deploying Qt4 +# executables. # # The following functions are provided by this module: -# write_qt4_conf -# resolve_qt4_paths -# fixup_qt4_executable -# install_qt4_plugin_path -# install_qt4_plugin -# install_qt4_executable +# +# :: +# +# write_qt4_conf +# resolve_qt4_paths +# fixup_qt4_executable +# install_qt4_plugin_path +# install_qt4_plugin +# install_qt4_executable +# # Requires CMake 2.6 or greater because it uses function and -# PARENT_SCOPE. Also depends on BundleUtilities.cmake. +# PARENT_SCOPE. Also depends on BundleUtilities.cmake. +# +# :: +# +# WRITE_QT4_CONF( ) # -# WRITE_QT4_CONF( ) # Writes a qt.conf file with the into . # -# RESOLVE_QT4_PATHS( []) +# :: +# +# RESOLVE_QT4_PATHS( []) +# # Loop through list and if any don't exist resolve them -# relative to the (if supplied) or the CMAKE_INSTALL_PREFIX. +# relative to the (if supplied) or the +# CMAKE_INSTALL_PREFIX. +# +# :: # -# FIXUP_QT4_EXECUTABLE( [ ]) -# Copies Qt plugins, writes a Qt configuration file (if needed) and fixes up a -# Qt4 executable using BundleUtilities so it is standalone and can be -# drag-and-drop copied to another machine as long as all of the system -# libraries are compatible. +# FIXUP_QT4_EXECUTABLE( [ ]) +# +# Copies Qt plugins, writes a Qt configuration file (if needed) and +# fixes up a Qt4 executable using BundleUtilities so it is standalone +# and can be drag-and-drop copied to another machine as long as all of +# the system libraries are compatible. # # should point to the executable to be fixed-up. # -# should contain a list of the names or paths of any Qt plugins -# to be installed. +# should contain a list of the names or paths of any Qt +# plugins to be installed. # -# will be passed to BundleUtilities and should be a list of any already -# installed plugins, libraries or executables to also be fixed-up. +# will be passed to BundleUtilities and should be a list of any +# already installed plugins, libraries or executables to also be +# fixed-up. # -# will be passed to BundleUtilities and should contain and directories -# to be searched to find library dependencies. +# will be passed to BundleUtilities and should contain and +# directories to be searched to find library dependencies. # # allows an custom plugins directory to be used. # -# will force a qt.conf file to be written even if not needed. +# will force a qt.conf file to be written even if not +# needed. +# +# :: +# +# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var ) # -# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var ) # Install (or copy) a resolved to the default plugins directory # (or ) relative to and store the result in # . # # If is set to TRUE then the plugins will be copied rather than -# installed. This is to allow this module to be used at CMake time rather than -# install time. +# installed. This is to allow this module to be used at CMake time +# rather than install time. # # If is set then anything installed will use this COMPONENT. # -# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var ) -# Install (or copy) an unresolved to the default plugins directory -# (or ) relative to and store the result in -# . See documentation of INSTALL_QT4_PLUGIN_PATH. -# -# INSTALL_QT4_EXECUTABLE( [ ]) -# Installs Qt plugins, writes a Qt configuration file (if needed) and fixes up -# a Qt4 executable using BundleUtilities so it is standalone and can be -# drag-and-drop copied to another machine as long as all of the system -# libraries are compatible. The executable will be fixed-up at install time. -# is the COMPONENT used for bundle fixup and plugin installation. -# See documentation of FIXUP_QT4_BUNDLE. +# :: +# +# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var ) +# +# Install (or copy) an unresolved to the default plugins +# directory (or ) relative to and store the +# result in . See documentation of +# INSTALL_QT4_PLUGIN_PATH. +# +# :: +# +# INSTALL_QT4_EXECUTABLE( [ ]) +# +# Installs Qt plugins, writes a Qt configuration file (if needed) and +# fixes up a Qt4 executable using BundleUtilities so it is standalone +# and can be drag-and-drop copied to another machine as long as all of +# the system libraries are compatible. The executable will be fixed-up +# at install time. is the COMPONENT used for bundle fixup +# and plugin installation. See documentation of FIXUP_QT4_BUNDLE. #============================================================================= # Copyright 2011 Mike McQuaid -- cgit v1.2.1