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

CPackIFW: Format documentation 

Place command documentation in explicit markup blocks and remove
horizontal dividers.  Use definition lists and bullet lists as
appropriate.
This commit is contained in:
Brad King 2016-09-16 10:40:03 -04:00
parent c2f0f41f63
commit a327b20694
1 changed files with 107 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
Modules/CPackIFW.cmake
View File

@ -181,8 +181,6 @@
# #
# The module defines the following commands: # The module defines the following commands:
# #
# --------------------------------------------------------------------------
#
# .. command:: cpack_ifw_configure_component # .. command:: cpack_ifw_configure_component
# #
# Sets the arguments specific to the CPack IFW generator. # Sets the arguments specific to the CPack IFW generator.
@ -200,31 +198,39 @@
# #
# This command should be called after :command:`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.
# #
# ``ESSENTIAL`` if set, then the package manager stays disabled until that # ``ESSENTIAL``
# if set, then the package manager stays disabled until that
# component is updated. # component is updated.
# #
# ``NAME`` is used to create domain-like identification for this component. # ``NAME``
# is used to create domain-like identification for this component.
# By default used origin component name. # 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.
# #
# ``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.
# #
# ``LICENSES`` pair of <display_name> and <file_path> of license text for this # ``LICENSES``
# pair of <display_name> and <file_path> of license text for this
# component. You can specify more then one license. # component. You can specify more then one license.
# #
# ``USER_INTERFACES`` a list of <file_path> representing pages to load # ``USER_INTERFACES``
# a list of <file_path> representing pages to load
# #
# --------------------------------------------------------------------------
# #
# .. command:: cpack_ifw_configure_component_group # .. command:: cpack_ifw_configure_component_group
# #
@ -243,24 +249,28 @@
# This command should be called after :command:`cpack_add_component_group` # This command should be called after :command:`cpack_add_component_group`
# command. # command.
# #
# ``NAME`` is used to create domain-like identification for this component # ``NAME``
# group. # is used to create domain-like identification for this component group.
# By default used origin component group name. # 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`.
# #
# ``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.
# #
# ``PRIORITY`` is priority of the component group in the tree. # ``PRIORITY``
# is priority of the component group in the tree.
# #
# ``LICENSES`` pair of <display_name> and <file_path> of license text for this # ``LICENSES``
# pair of <display_name> and <file_path> of license text for this
# component group. You can specify more then one license. # component group. You can specify more then one license.
# #
# ``USER_INTERFACES`` a list of <file_path> representing pages to load # ``USER_INTERFACES``
# a list of <file_path> representing pages to load
# #
# --------------------------------------------------------------------------
# #
# .. command:: cpack_ifw_add_repository # .. command:: cpack_ifw_add_repository
# #
@ -277,19 +287,22 @@
# This command 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.
# #
# ``URL`` is points to a list of available components. # ``URL``
# is points to a list of available components.
# #
# ``USERNAME`` is used as user on a protected repository. # ``USERNAME``
# is used as user on a protected repository.
# #
# ``PASSWORD`` is password to use on a protected repository. # ``PASSWORD``
# is password to use on a protected repository.
# #
# ``DISPLAY_NAME`` is string to display instead of the URL. # ``DISPLAY_NAME``
# is string to display instead of the URL.
# #
# #
# --------------------------------------------------------------------------
#
# .. command:: cpack_ifw_update_repository # .. command:: cpack_ifw_update_repository
# #
# Update QtIFW_ specific repository from remote repository. # Update QtIFW_ specific repository from remote repository.
@ -306,17 +319,23 @@
# This command 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`.
# #
# ``URL`` is points to a list of available components. # ``URL``
# is points to a list of available components.
# #
# ``OLD_URL`` is points to a list that will replaced. # ``OLD_URL``
# is points to a list that will replaced.
# #
# ``NEW_URL`` is points to a list that will replace to. # ``NEW_URL``
# is points to a list that will replace to.
# #
# ``USERNAME`` is used as user on a protected repository. # ``USERNAME``
# is used as user on a protected repository.
# #
# ``PASSWORD`` is password to use on a protected repository. # ``PASSWORD``
# is password to use on a protected repository.
# #
# ``DISPLAY_NAME`` is string to display instead of the URL. # ``DISPLAY_NAME``
# is string to display instead of the URL.
# #
# Example usage # Example usage
# ^^^^^^^^^^^^^ # ^^^^^^^^^^^^^
@ -368,16 +387,16 @@
# #
# Qt Installer Framework Manual: # Qt Installer Framework Manual:
# #
# Index page # * Index page:
# http://doc.qt.io/qtinstallerframework/index.html # http://doc.qt.io/qtinstallerframework/index.html
# #
# Component Scripting # * Component Scripting:
# http://doc.qt.io/qtinstallerframework/scripting.html # http://doc.qt.io/qtinstallerframework/scripting.html
# #
# Predefined Variables # * Predefined Variables:
# http://doc.qt.io/qtinstallerframework/scripting.html#predefined-variables # http://doc.qt.io/qtinstallerframework/scripting.html#predefined-variables
# #
# Promoting Updates # * Promoting Updates:
# http://doc.qt.io/qtinstallerframework/ifw-updates.html # http://doc.qt.io/qtinstallerframework/ifw-updates.html
# #
# Download Qt Installer Framework for you platform from Qt site: # Download Qt Installer Framework for you platform from Qt site: