mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-05 21:31:08 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Convert DeployQt4 to block-style comment

Browse Source
This commit is contained in:
Kyle Edwards
2018-10-17 10:11:15 -04:00
parent 09daee0780
commit 9bfb63bd42
1 changed files with 101 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

201
Modules/DeployQt4.cmake
View File

@@ -1,106 +1,107 @@
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details. # file Copyright.txt or https://cmake.org/licensing for details.
#.rst: #[=======================================================================[.rst:
# DeployQt4 DeployQt4
# --------- ---------
#
# Functions to help assemble a standalone Qt4 executable. Functions to help assemble a standalone Qt4 executable.
#
# A collection of CMake utility functions useful for deploying Qt4 A collection of CMake utility functions useful for deploying Qt4
# executables. executables.
#
# The following functions are provided by this module: The following functions are provided by this module:
#
# :: ::
#
# write_qt4_conf write_qt4_conf
# resolve_qt4_paths resolve_qt4_paths
# fixup_qt4_executable fixup_qt4_executable
# install_qt4_plugin_path install_qt4_plugin_path
# install_qt4_plugin install_qt4_plugin
# install_qt4_executable install_qt4_executable
#
# Requires CMake 2.6 or greater because it uses function and 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(<qt_conf_dir> <qt_conf_contents>) WRITE_QT4_CONF(<qt_conf_dir> <qt_conf_contents>)
#
# Writes a qt.conf file with the <qt_conf_contents> into <qt_conf_dir>. Writes a qt.conf file with the <qt_conf_contents> into <qt_conf_dir>.
#
# :: ::
#
# RESOLVE_QT4_PATHS(<paths_var> [<executable_path>]) RESOLVE_QT4_PATHS(<paths_var> [<executable_path>])
#
# Loop through <paths_var> list and if any don't exist resolve them Loop through <paths_var> list and if any don't exist resolve them
# relative to the <executable_path> (if supplied) or the relative to the <executable_path> (if supplied) or the
# CMAKE_INSTALL_PREFIX. CMAKE_INSTALL_PREFIX.
#
# :: ::
#
# FIXUP_QT4_EXECUTABLE(<executable> FIXUP_QT4_EXECUTABLE(<executable>
# [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>]) [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf>])
#
# Copies Qt plugins, writes a Qt configuration file (if needed) and Copies Qt plugins, writes a Qt configuration file (if needed) and
# fixes up a Qt4 executable using BundleUtilities so it is standalone 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 and can be drag-and-drop copied to another machine as long as all of
# the system libraries are compatible. the system libraries are compatible.
#
# <executable> should point to the executable to be fixed-up. <executable> should point to the executable to be fixed-up.
#
# <qtplugins> should contain a list of the names or paths of any Qt <qtplugins> should contain a list of the names or paths of any Qt
# plugins to be installed. plugins to be installed.
#
# <libs> will be passed to BundleUtilities and should be a list of any <libs> will be passed to BundleUtilities and should be a list of any
# already installed plugins, libraries or executables to also be already installed plugins, libraries or executables to also be
# fixed-up. fixed-up.
#
# <dirs> will be passed to BundleUtilities and should contain and <dirs> will be passed to BundleUtilities and should contain and
# directories to be searched to find library dependencies. directories to be searched to find library dependencies.
#
# <plugins_dir> allows an custom plugins directory to be used. <plugins_dir> allows an custom plugins directory to be used.
#
# <request_qt_conf> will force a qt.conf file to be written even if not <request_qt_conf> will force a qt.conf file to be written even if not
# needed. needed.
#
# :: ::
#
# INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var
# <plugins_dir> <component> <configurations>) <plugins_dir> <component> <configurations>)
#
# Install (or copy) a resolved <plugin> to the default plugins directory Install (or copy) a resolved <plugin> to the default plugins directory
# (or <plugins_dir>) relative to <executable> and store the result in (or <plugins_dir>) relative to <executable> and store the result in
# <installed_plugin_path_var>. <installed_plugin_path_var>.
#
# If <copy> is set to TRUE then the plugins will be copied rather than If <copy> 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 installed. This is to allow this module to be used at CMake time
# rather than install time. rather than install time.
#
# If <component> is set then anything installed will use this COMPONENT. If <component> is set then anything installed will use this COMPONENT.
#
# :: ::
#
# INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var
# <plugins_dir> <component>) <plugins_dir> <component>)
#
# Install (or copy) an unresolved <plugin> to the default plugins Install (or copy) an unresolved <plugin> to the default plugins
# directory (or <plugins_dir>) relative to <executable> and store the directory (or <plugins_dir>) relative to <executable> and store the
# result in <installed_plugin_path_var>. See documentation of result in <installed_plugin_path_var>. See documentation of
# INSTALL_QT4_PLUGIN_PATH. INSTALL_QT4_PLUGIN_PATH.
#
# :: ::
#
# INSTALL_QT4_EXECUTABLE(<executable> INSTALL_QT4_EXECUTABLE(<executable>
# [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>]) [<qtplugins> <libs> <dirs> <plugins_dir> <request_qt_conf> <component>])
#
# Installs Qt plugins, writes a Qt configuration file (if needed) and Installs Qt plugins, writes a Qt configuration file (if needed) and
# fixes up a Qt4 executable using BundleUtilities so it is standalone 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 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 the system libraries are compatible. The executable will be fixed-up
# at install time. <component> is the COMPONENT used for bundle fixup at install time. <component> is the COMPONENT used for bundle fixup
# and plugin installation. See documentation of FIXUP_QT4_BUNDLE. and plugin installation. See documentation of FIXUP_QT4_BUNDLE.
#]=======================================================================]
# The functions defined in this file depend on the fixup_bundle function # The functions defined in this file depend on the fixup_bundle function
# (and others) found in BundleUtilities.cmake # (and others) found in BundleUtilities.cmake