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

Merge topic 'doc_fixes' 

76d6c59 Clean up documentation formatting so that it is rendered properly in HTML.
This commit is contained in:
David Cole 2012-08-13 13:28:16 -04:00 committed by CMake Topic Stage
parent c1163632de 76d6c59358
commit 396bc28477
2 changed files with 166 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

326
Modules/CPackComponent.cmake
View File

@ -28,31 +28,31 @@
##variable ##variable
# CPACK_COMPONENTS_ALL - The list of component to install. # CPACK_COMPONENTS_ALL - The list of component to install.
# #
# The default value of this variable is computed by CPack #The default value of this variable is computed by CPack
# and contains all components defined by the project. The #and contains all components defined by the project. The
# user may set it to only include the specified components. #user may set it to only include the specified components.
##end ##end
# #
##variable ##variable
# CPACK_<GENNAME>_COMPONENT_INSTALL - Enable/Disable component install for # CPACK_<GENNAME>_COMPONENT_INSTALL - Enable/Disable component install for
# CPack generator <GENNAME>. # CPack generator <GENNAME>.
# #
# Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a legacy #Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a legacy
# default behavior. e.g. RPM builds monolithic whereas NSIS builds component. #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 can change the default behavior by setting this variable to 0/1 or OFF/ON.
##end ##end
##variable ##variable
# CPACK_COMPONENTS_GROUPING - Specify how components are grouped for multi-package # CPACK_COMPONENTS_GROUPING - Specify how components are grouped for multi-package
# component-aware CPack generators. # component-aware CPack generators.
# #
# Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates several #Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates several
# packages files when asked for component packaging. They group the component #packages files when asked for component packaging. They group the component
# differently depending on the value of this variable: #differently depending on the value of this variable:
# - ONE_PER_GROUP (default): creates one package file per component group # - ONE_PER_GROUP (default): creates one package file per component group
# - ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component # - ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component
# - IGNORE : creates one package per component, i.e. IGNORE component group # - IGNORE : creates one package per component, i.e. IGNORE component group
# One can specify different grouping for different CPack generator by using #One can specify different grouping for different CPack generator by using
# a CPACK_PROJECT_CONFIG_FILE. #a CPACK_PROJECT_CONFIG_FILE.
##end ##end
##variable ##variable
# CPACK_COMPONENT_<compName>_DISPLAY_NAME - The name to be displayed for a component. # CPACK_COMPONENT_<compName>_DISPLAY_NAME - The name to be displayed for a component.
@ -71,194 +71,194 @@
# CPACK_COMPONENT_<compName>_REQUIRED - True is this component is required. # CPACK_COMPONENT_<compName>_REQUIRED - True is this component is required.
##end ##end
##macro ##macro
# cpack_add_component - Describes a CPack installation component #cpack_add_component - Describes a CPack installation component
# named by the COMPONENT argument to a CMake INSTALL command. #named by the COMPONENT argument to a CMake INSTALL command.
# #
# cpack_add_component(compname # cpack_add_component(compname
# [DISPLAY_NAME name] # [DISPLAY_NAME name]
# [DESCRIPTION description] # [DESCRIPTION description]
# [HIDDEN | REQUIRED | DISABLED ] # [HIDDEN | REQUIRED | DISABLED ]
# [GROUP group] # [GROUP group]
# [DEPENDS comp1 comp2 ... ] # [DEPENDS comp1 comp2 ... ]
# [INSTALL_TYPES type1 type2 ... ] # [INSTALL_TYPES type1 type2 ... ]
# [DOWNLOADED] # [DOWNLOADED]
# [ARCHIVE_FILE filename]) # [ARCHIVE_FILE filename])
# #
# The cmake_add_component command describes an installation #The cmake_add_component command describes an installation
# component, which the user can opt to install or remove as part of #component, which the user can opt to install or remove as part of
# the graphical installation process. compname is the name of the #the graphical installation process. compname is the name of the
# component, as provided to the COMPONENT argument of one or more #component, as provided to the COMPONENT argument of one or more
# CMake INSTALL commands. #CMake INSTALL commands.
# #
# DISPLAY_NAME is the displayed name of the component, used in #DISPLAY_NAME is the displayed name of the component, used in
# graphical installers to display the component name. This value can #graphical installers to display the component name. This value can
# be any string. #be any string.
# #
# DESCRIPTION is an extended description of the component, used in #DESCRIPTION is an extended description of the component, used in
# graphical installers to give the user additional information about #graphical installers to give the user additional information about
# the component. Descriptions can span multiple lines using "\n" as #the component. Descriptions can span multiple lines using "\n" as
# the line separator. Typically, these descriptions should be no #the line separator. Typically, these descriptions should be no
# more than a few lines long. #more than a few lines long.
# #
# HIDDEN indicates that this component will be hidden in the #HIDDEN indicates that this component will be hidden in the
# graphical installer, so that the user cannot directly change #graphical installer, so that the user cannot directly change
# whether it is installed or not. #whether it is installed or not.
# #
# REQUIRED indicates that this component is required, and therefore #REQUIRED indicates that this component is required, and therefore
# will always be installed. It will be visible in the graphical #will always be installed. It will be visible in the graphical
# installer, but it cannot be unselected. (Typically, required #installer, but it cannot be unselected. (Typically, required
# components are shown greyed out). #components are shown greyed out).
# #
# DISABLED indicates that this component should be disabled #DISABLED indicates that this component should be disabled
# (unselected) by default. The user is free to select this component #(unselected) by default. The user is free to select this component
# for installation, unless it is also HIDDEN. #for installation, unless it is also HIDDEN.
# #
# DEPENDS lists the components on which this component depends. If #DEPENDS lists the components on which this component depends. If
# this component is selected, then each of the components listed #this component is selected, then each of the components listed
# must also be selected. The dependency information is encoded #must also be selected. The dependency information is encoded
# within the installer itself, so that users cannot install #within the installer itself, so that users cannot install
# inconsitent sets of components. #inconsistent sets of components.
# #
# GROUP names the component group of which this component is a #GROUP names the component group of which this component is a
# part. If not provided, the component will be a standalone #part. If not provided, the component will be a standalone
# component, not part of any component group. Component groups are #component, not part of any component group. Component groups are
# described with the cpack_add_component_group command, detailed #described with the cpack_add_component_group command, detailed
# below. #below.
# #
# INSTALL_TYPES lists the installation types of which this component #INSTALL_TYPES lists the installation types of which this component
# is a part. When one of these installations types is selected, this #is a part. When one of these installations types is selected, this
# component will automatically be selected. Installation types are #component will automatically be selected. Installation types are
# described with the cpack_add_install_type command, detailed below. #described with the cpack_add_install_type command, detailed below.
# #
# DOWNLOADED indicates that this component should be downloaded #DOWNLOADED indicates that this component should be downloaded
# on-the-fly by the installer, rather than packaged in with the #on-the-fly by the installer, rather than packaged in with the
# installer itself. For more information, see the cpack_configure_downloads #installer itself. For more information, see the cpack_configure_downloads
# command. # command.
# #
# ARCHIVE_FILE provides a name for the archive file created by CPack #ARCHIVE_FILE provides a name for the archive file created by CPack
# to be used for downloaded components. If not supplied, CPack will #to be used for downloaded components. If not supplied, CPack will
# create a file with some name based on CPACK_PACKAGE_FILE_NAME and #create a file with some name based on CPACK_PACKAGE_FILE_NAME and
# the name of the component. See cpack_configure_downloads for more #the name of the component. See cpack_configure_downloads for more
# information. #information.
##end ##end
# #
##macro ##macro
# cpack_add_component_group - Describes a group of related CPack #cpack_add_component_group - Describes a group of related CPack
# installation components. #installation components.
# #
# cpack_add_component_group(groupname # cpack_add_component_group(groupname
# [DISPLAY_NAME name] # [DISPLAY_NAME name]
# [DESCRIPTION description] # [DESCRIPTION description]
# [PARENT_GROUP parent] # [PARENT_GROUP parent]
# [EXPANDED] # [EXPANDED]
# [BOLD_TITLE]) # [BOLD_TITLE])
# #
# The cpack_add_component_group describes a group of installation #The cpack_add_component_group describes a group of installation
# components, which will be placed together within the listing of #components, which will be placed together within the listing of
# options. Typically, component groups allow the user to #options. Typically, component groups allow the user to
# select/deselect all of the components within a single group via a #select/deselect all of the components within a single group via a
# single group-level option. Use component groups to reduce the #single group-level option. Use component groups to reduce the
# complexity of installers with many options. groupname is an #complexity of installers with many options. groupname is an
# arbitrary name used to identify the group in the GROUP argument of #arbitrary name used to identify the group in the GROUP argument of
# the cpack_add_component command, which is used to place a #the cpack_add_component command, which is used to place a
# component in a group. The name of the group must not conflict with #component in a group. The name of the group must not conflict with
# the name of any component. #the name of any component.
# #
# DISPLAY_NAME is the displayed name of the component group, used in #DISPLAY_NAME is the displayed name of the component group, used in
# graphical installers to display the component group name. This #graphical installers to display the component group name. This
# value can be any string. #value can be any string.
# #
# DESCRIPTION is an extended description of the component group, #DESCRIPTION is an extended description of the component group,
# used in graphical installers to give the user additional #used in graphical installers to give the user additional
# information about the components within that group. Descriptions #information about the components within that group. Descriptions
# can span multiple lines using "\n" as the line #can span multiple lines using "\n" as the line
# separator. Typically, these descriptions should be no more than a #separator. Typically, these descriptions should be no more than a
# few lines long. #few lines long.
# #
# PARENT_GROUP, if supplied, names the parent group of this group. #PARENT_GROUP, if supplied, names the parent group of this group.
# Parent groups are used to establish a hierarchy of groups, #Parent groups are used to establish a hierarchy of groups,
# providing an arbitrary hierarchy of groups. #providing an arbitrary hierarchy of groups.
# #
# EXPANDED indicates that, by default, the group should show up as #EXPANDED indicates that, by default, the group should show up as
# "expanded", so that the user immediately sees all of the #"expanded", so that the user immediately sees all of the
# components within the group. Otherwise, the group will initially #components within the group. Otherwise, the group will initially
# show up as a single entry. #show up as a single entry.
# #
# BOLD_TITLE indicates that the group title should appear in bold, #BOLD_TITLE indicates that the group title should appear in bold,
# to call the user's attention to the group. #to call the user's attention to the group.
##end ##end
# #
##macro ##macro
# cpack_add_install_type - Add a new installation type containing a #cpack_add_install_type - Add a new installation type containing a
# set of predefined component selections to the graphical installer. #set of predefined component selections to the graphical installer.
# #
# cpack_add_install_type(typename # cpack_add_install_type(typename
# [DISPLAY_NAME name]) # [DISPLAY_NAME name])
# #
# The cpack_add_install_type command identifies a set of preselected #The cpack_add_install_type command identifies a set of preselected
# components that represents a common use case for an #components that represents a common use case for an
# application. For example, a "Developer" install type might include #application. For example, a "Developer" install type might include
# an application along with its header and library files, while an #an application along with its header and library files, while an
# "End user" install type might just include the application's #"End user" install type might just include the application's
# executable. Each component identifies itself with one or more #executable. Each component identifies itself with one or more
# install types via the INSTALL_TYPES argument to #install types via the INSTALL_TYPES argument to
# cpack_add_component. #cpack_add_component.
# #
# DISPLAY_NAME is the displayed name of the install type, which will #DISPLAY_NAME is the displayed name of the install type, which will
# typically show up in a drop-down box within a graphical #typically show up in a drop-down box within a graphical
# installer. This value can be any string. #installer. This value can be any string.
##end ##end
# #
##macro ##macro
# cpack_configure_downloads - Configure CPack to download selected #cpack_configure_downloads - Configure CPack to download selected
# components on-the-fly as part of the installation process. #components on-the-fly as part of the installation process.
# #
# cpack_configure_downloads(site # cpack_configure_downloads(site
# [UPLOAD_DIRECTORY dirname] # [UPLOAD_DIRECTORY dirname]
# [ALL] # [ALL]
# [ADD_REMOVE|NO_ADD_REMOVE]) # [ADD_REMOVE|NO_ADD_REMOVE])
# #
# The cpack_configure_downloads command configures installation-time #The cpack_configure_downloads command configures installation-time
# downloads of selected components. For each downloadable component, #downloads of selected components. For each downloadable component,
# CPack will create an archive containing the contents of that #CPack will create an archive containing the contents of that
# component, which should be uploaded to the given site. When the #component, which should be uploaded to the given site. When the
# user selects that component for installation, the installer will #user selects that component for installation, the installer will
# download and extract the component in place. This feature is #download and extract the component in place. This feature is
# useful for creating small installers that only download the #useful for creating small installers that only download the
# requested components, saving bandwidth. Additionally, the #requested components, saving bandwidth. Additionally, the
# installers are small enough that they will be installed as part of #installers are small enough that they will be installed as part of
# the normal installation process, and the "Change" button in #the normal installation process, and the "Change" button in
# Windows Add/Remove Programs control panel will allow one to add or #Windows Add/Remove Programs control panel will allow one to add or
# remove parts of the application after the original #remove parts of the application after the original
# installation. On Windows, the downloaded-components functionality #installation. On Windows, the downloaded-components functionality
# requires the ZipDLL plug-in for NSIS, available at: #requires the ZipDLL plug-in for NSIS, available at:
# #
# http://nsis.sourceforge.net/ZipDLL_plug-in # http://nsis.sourceforge.net/ZipDLL_plug-in
# #
# On Mac OS X, installers that download components on-the-fly can #On Mac OS X, installers that download components on-the-fly can
# only be built and installed on system using Mac OS X 10.5 or #only be built and installed on system using Mac OS X 10.5 or
# later. #later.
# #
# The site argument is a URL where the archives for downloadable #The site argument is a URL where the archives for downloadable
# components will reside, e.g., http://www.cmake.org/files/2.6.1/installer/ #components will reside, e.g., http://www.cmake.org/files/2.6.1/installer/
# All of the archives produced by CPack should be uploaded to that location. #All of the archives produced by CPack should be uploaded to that location.
# #
# UPLOAD_DIRECTORY is the local directory where CPack will create the #UPLOAD_DIRECTORY is the local directory where CPack will create the
# various archives for each of the components. The contents of this #various archives for each of the components. The contents of this
# directory should be uploaded to a location accessible by the URL given #directory should be uploaded to a location accessible by the URL given
# in the site argument. If omitted, CPack will use the directory #in the site argument. If omitted, CPack will use the directory
# CPackUploads inside the CMake binary directory to store the generated #CPackUploads inside the CMake binary directory to store the generated
# archives. #archives.
# #
# The ALL flag indicates that all components be downloaded. Otherwise, only #The ALL flag indicates that all components be downloaded. Otherwise, only
# those components explicitly marked as DOWNLOADED or that have a specified #those components explicitly marked as DOWNLOADED or that have a specified
# ARCHIVE_FILE will be downloaded. Additionally, the ALL option implies #ARCHIVE_FILE will be downloaded. Additionally, the ALL option implies
# ADD_REMOVE (unless NO_ADD_REMOVE is specified). #ADD_REMOVE (unless NO_ADD_REMOVE is specified).
# #
# ADD_REMOVE indicates that CPack should install a copy of the installer #ADD_REMOVE indicates that CPack should install a copy of the installer
# that can be called from Windows' Add/Remove Programs dialog (via the #that can be called from Windows' Add/Remove Programs dialog (via the
# "Modify" button) to change the set of installed components. NO_ADD_REMOVE #"Modify" button) to change the set of installed components. NO_ADD_REMOVE
# turns off this behavior. This option is ignored on Mac OS X. #turns off this behavior. This option is ignored on Mac OS X.
##endmacro ##endmacro
#============================================================================= #=============================================================================

6
Source/cmDocumentVariables.cxx
View File

@ -831,9 +831,9 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
"the shared MFC library. This is used in visual " "the shared MFC library. This is used in visual "
"studio 6 and 7 project files. The CMakeSetup " "studio 6 and 7 project files. The CMakeSetup "
"dialog used MFC and the CMakeLists.txt looks like this:\n" "dialog used MFC and the CMakeLists.txt looks like this:\n"
"add_definitions(-D_AFXDLL)\n" " add_definitions(-D_AFXDLL)\n"
"set(CMAKE_MFC_FLAG 2)\n" " set(CMAKE_MFC_FLAG 2)\n"
"add_executable(CMakeSetup WIN32 ${SRCS})\n",false, " add_executable(CMakeSetup WIN32 ${SRCS})\n",false,
"Variables That Change Behavior"); "Variables That Change Behavior");
cm->DefineProperty cm->DefineProperty