kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CPackIFW: Doc decoration

This commit is contained in:
Konstantin Podsvirov 2016-05-23 12:42:28 +03:00
parent c75d91a05c
commit 222fa595cd
1 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
Modules/CPackIFW.cmake
View File

@ -4,8 +4,8 @@
# #
# .. _QtIFW: http://doc.qt.io/qtinstallerframework/index.html # .. _QtIFW: http://doc.qt.io/qtinstallerframework/index.html
# #
# This module looks for the location of the command line utilities supplied with # This module looks for the location of the command line utilities supplied
# the Qt Installer Framework (QtIFW_). # with the Qt Installer Framework (QtIFW_).
# #
# The module also defines several commands to control the behavior of the # The module also defines several commands to control the behavior of the
# CPack ``IFW`` generator. # CPack ``IFW`` generator.
@ -31,7 +31,8 @@
# Variables # Variables
# ^^^^^^^^^ # ^^^^^^^^^
# #
# You can use the following variables to change behavior of CPack ``IFW`` generator. # You can use the following variables to change behavior of CPack ``IFW``
# generator.
# #
# Debug # Debug
# """""" # """"""
@ -65,7 +66,8 @@
# #
# .. variable:: CPACK_IFW_PACKAGE_WINDOW_ICON # .. variable:: CPACK_IFW_PACKAGE_WINDOW_ICON
# #
# Filename for a custom window icon in PNG format for the Installer application. # Filename for a custom window icon in PNG format for the Installer
# application.
# #
# .. variable:: CPACK_IFW_PACKAGE_LOGO # .. variable:: CPACK_IFW_PACKAGE_LOGO
# #
@ -80,7 +82,8 @@
# .. variable:: CPACK_IFW_TARGET_DIRECTORY # .. variable:: CPACK_IFW_TARGET_DIRECTORY
# #
# Default target directory for installation. # Default target directory for installation.
# By default used "@ApplicationsDir@/:variable:`CPACK_PACKAGE_INSTALL_DIRECTORY`" # By default used
# "@ApplicationsDir@/:variable:`CPACK_PACKAGE_INSTALL_DIRECTORY`"
# #
# You can use predefined variables. # You can use predefined variables.
# #
@ -194,20 +197,20 @@
# [DEPENDS <com_id> ...] # [DEPENDS <com_id> ...]
# [LICENSES <display_name> <file_path> ...]) # [LICENSES <display_name> <file_path> ...])
# #
# This command should be called after cpack_add_component command. # This command should be called after :command:`cpack_add_component` command.
# #
# ``COMMON`` if set, then the component will be packaged and installed as part # ``COMMON`` if set, then the component will be packaged and installed as part
# of a group to which it belongs. # of a group to which it belongs.
# #
# ``NAME`` is used to create domain-like identification for this component.
# By default used origin component name.
#
# ``VERSION`` is version of component. # ``VERSION`` is version of component.
# By default used :variable:`CPACK_PACKAGE_VERSION`. # By default used :variable:`CPACK_PACKAGE_VERSION`.
# #
# ``SCRIPT`` is a relative or absolute path to operations script # ``SCRIPT`` is a relative or absolute path to operations script
# for this component. # for this component.
# #
# ``NAME`` is used to create domain-like identification for this component.
# By default used origin component name.
#
# ``PRIORITY`` is priority of the component in the tree. # ``PRIORITY`` is priority of the component in the tree.
# #
# ``DEPENDS`` list of dependency component identifiers in QtIFW_ style. # ``DEPENDS`` list of dependency component identifiers in QtIFW_ style.
@ -223,21 +226,23 @@
# #
# :: # ::
# #
# cpack_ifw_configure_component_group(<grpname> # cpack_ifw_configure_component_group(<groupname>
# [VERSION <version>]
# [NAME <name>] # [NAME <name>]
# [VERSION <version>]
# [SCRIPT <script>] # [SCRIPT <script>]
# [PRIORITY <priority>] # [PRIORITY <priority>]
# [LICENSES <display_name> <file_path> ...]) # [LICENSES <display_name> <file_path> ...])
# #
# This command should be called after cpack_add_component_group command. # This command should be called after :command:`cpack_add_component_group`
# command.
#
# ``NAME`` is used to create domain-like identification for this component
# group.
# By default used origin component group name.
# #
# ``VERSION`` is version of component group. # ``VERSION`` is version of component group.
# By default used :variable:`CPACK_PACKAGE_VERSION`. # By default used :variable:`CPACK_PACKAGE_VERSION`.
# #
# ``NAME`` is used to create domain-like identification for this component group.
# By default used origin component group name.
#
# ``SCRIPT`` is a relative or absolute path to operations script # ``SCRIPT`` is a relative or absolute path to operations script
# for this component group. # for this component group.
# #
@ -260,8 +265,8 @@
# [PASSWORD <password>] # [PASSWORD <password>]
# [DISPLAY_NAME <display_name>]) # [DISPLAY_NAME <display_name>])
# #
# This macro will also add the <reponame> repository # This command will also add the <reponame> repository
# to a variable :variable:`CPACK_IFW_REPOSITORIES_ALL` # to a variable :variable:`CPACK_IFW_REPOSITORIES_ALL`.
# #
# ``DISABLED`` if set, then the repository will be disabled by default. # ``DISABLED`` if set, then the repository will be disabled by default.
# #
@ -289,9 +294,8 @@
# [PASSWORD <password>] # [PASSWORD <password>]
# [DISPLAY_NAME <display_name>]) # [DISPLAY_NAME <display_name>])
# #
# Specified will # This command will also add the <reponame> repository
# This macro will also add the repository action # to a variable :variable:`CPACK_IFW_REPOSITORIES_ALL`.
# to a variable :variable:`CPACK_IFW_REPOSITORIES_ALL`
# #
# ``URL`` is points to a list of available components. # ``URL`` is points to a list of available components.
# #
@ -542,7 +546,7 @@ macro(cpack_ifw_configure_component compname)
string(TOUPPER ${compname} _CPACK_IFWCOMP_UNAME) string(TOUPPER ${compname} _CPACK_IFWCOMP_UNAME)
set(_IFW_OPT COMMON) set(_IFW_OPT COMMON)
set(_IFW_ARGS VERSION SCRIPT NAME PRIORITY) set(_IFW_ARGS NAME VERSION SCRIPT PRIORITY)
set(_IFW_MULTI_ARGS DEPENDS LICENSES) set(_IFW_MULTI_ARGS DEPENDS LICENSES)
cmake_parse_arguments(CPACK_IFW_COMPONENT_${_CPACK_IFWCOMP_UNAME} "${_IFW_OPT}" "${_IFW_ARGS}" "${_IFW_MULTI_ARGS}" ${ARGN}) cmake_parse_arguments(CPACK_IFW_COMPONENT_${_CPACK_IFWCOMP_UNAME} "${_IFW_OPT}" "${_IFW_ARGS}" "${_IFW_MULTI_ARGS}" ${ARGN})