diff options
author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 17:23:23 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:39 (GMT) |
commit | a77e3086938d46c56f62901531245711dbd55cc4 (patch) | |
tree | 310f64bed6b69c741cbd1ec4e2be8177004d86e2 /Modules/CPackWIX.cmake | |
parent | e7ca48f226782e7354a7ea9d6f9cef58e8773306 (diff) | |
download | CMake-a77e3086938d46c56f62901531245711dbd55cc4.zip CMake-a77e3086938d46c56f62901531245711dbd55cc4.tar.gz CMake-a77e3086938d46c56f62901531245711dbd55cc4.tar.bz2 |
CPack: Replace #<type> markup with reStructuredText equivalent
Drop #end and #module. Convert #section to a subsection header.
Convert #variable to the cmake domain "variable" directive.
Convert #macro to the cmake domain "command" directive.
Perform minor formatting fixes in text near these changes.
Diffstat (limited to 'Modules/CPackWIX.cmake')
-rw-r--r-- | Modules/CPackWIX.cmake | 152 |
1 files changed, 71 insertions, 81 deletions
diff --git a/Modules/CPackWIX.cmake b/Modules/CPackWIX.cmake index 2634f5f..7c7d924 100644 --- a/Modules/CPackWIX.cmake +++ b/Modules/CPackWIX.cmake @@ -4,135 +4,125 @@ # # CPack WiX generator specific options # -# #section Variables specific to CPack WiX generator #end #module +# Variables specific to CPack WiX generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # # The following variables are specific to the installers built on -# Windows using WiX. #end #variable +# Windows using WiX. # -# :: +# .. variable:: CPACK_WIX_UPGRADE_GUID # -# CPACK_WIX_UPGRADE_GUID - Upgrade GUID (Product/@UpgradeCode) +# Upgrade GUID (Product/@UpgradeCode) # +# Will be automatically generated unless explicitly provided. # +# It should be explicitly set to a constant generated gloabally unique +# identifier (GUID) to allow your installers to replace existing +# installations that use the same GUID. # -# Will be automatically generated unless explicitly provided. +# You may for example explicitly set this variable in your +# CMakeLists.txt to the value that has been generated per default. You +# should not use GUIDs that you did not generate yourself or which may +# belong to other projects. # -# It should be explicitly set to a constant generated gloabally unique -# identifier (GUID) to allow your installers to replace existing -# installations that use the same GUID. +# A GUID shall have the following fixed length syntax:: # -# You may for example explicitly set this variable in your -# CMakeLists.txt to the value that has been generated per default. You -# should not use GUIDs that you did not generate yourself or which may -# belong to other projects. +# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX # -# A GUID shall have the following fixed length syntax: -# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +# (each X represents an uppercase hexadecimal digit) # -# :: +# .. variable:: CPACK_WIX_PRODUCT_GUID # -# (each X represents an uppercase hexadecimal digit) +# Product GUID (Product/@Id) # -# #end #variable +# Will be automatically generated unless explicitly provided. # -# :: +# If explicitly provided this will set the Product Id of your installer. # -# CPACK_WIX_PRODUCT_GUID - Product GUID (Product/@Id) +# The installer will abort if it detects a pre-existing installation that +# uses the same GUID. # +# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID. # +# .. variable:: CPACK_WIX_LICENSE_RTF # -# Will be automatically generated unless explicitly provided. +# RTF License File # -# If explicitly provided this will set the Product Id of your installer. +# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is. # -# The installer will abort if it detects a pre-existing installation -# that uses the same GUID. +# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly +# converted to RTF by the WiX Generator. # -# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID. -# #end #variable +# With CPACK_WIX_LICENSE_RTF you can override the license file used by the +# WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported +# format or the .txt -> .rtf conversion does not work as expected. # -# :: +# .. variable:: CPACK_WIX_PRODUCT_ICON # -# CPACK_WIX_LICENSE_RTF - RTF License File +# The Icon shown next to the program name in Add/Remove programs. # +# If set, this icon is used in place of the default icon. # +# .. variable:: CPACK_WIX_UI_BANNER # -# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is. +# The bitmap will appear at the top of all installer pages other than the +# welcome and completion dialogs. # -# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly -# converted to RTF by the WiX Generator. +# If set, this image will replace the default banner image. # -# With CPACK_WIX_LICENSE_RTF you can override the license file used by -# the WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an -# unsupported format or the .txt -> .rtf conversion does not work as -# expected. +# This image must be 493 by 58 pixels. # -# #end +# .. variable:: CPACK_WIX_UI_DIALOG # -# #variable CPACK_WIX_PRODUCT_ICON - The Icon shown next to the program -# name in Add/Remove programs. +# Background bitmap used on the welcome and completion dialogs. # -# If set, this icon is used in place of the default icon. +# If this variable is set, the installer will replace the default dialog +# image. # -# #end +# This image must be 493 by 312 pixels. # -# #variable CPACK_WIX_UI_BANNER - The bitmap will appear at the top of -# all installer pages other than the welcome and completion dialogs. +# .. variable:: CPACK_WIX_PROGRAM_MENU_FOLDER # -# If set, this image will replace the default banner image. +# Start menu folder name for launcher. # -# This image must be 493 by 58 pixels. +# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME # -# #end +# .. variable:: CPACK_WIX_CULTURES # -# #variable CPACK_WIX_UI_DIALOG - Background bitmap used on the welcome -# and completion dialogs. +# Language(s) of the installer # -# If this variable is set, the installer will replace the default dialog -# image. +# Languages are compiled into the WixUI extension library. To use them, +# simply provide the name of the culture. If you specify more than one +# culture identifier in a comma or semicolon delimited list, the first one +# that is found will be used. You can find a list of supported languages at: +# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm # -# This image must be 493 by 312 pixels. +# .. variable:: CPACK_WIX_TEMPLATE # -# #end +# Template file for WiX generation # -# #variable CPACK_WIX_PROGRAM_MENU_FOLDER - Start menu folder name for -# launcher. +# If this variable is set, the specified template will be used to generate +# the WiX wxs file. This should be used if further customization of the +# output is required. # -# If this variable is not set, it will be initialized with -# CPACK_PACKAGE_NAME +# If this variable is not set, the default MSI template included with CMake +# will be used. # -# #end #variable CPACK_WIX_CULTURES - Language(s) of the installer +# .. variable:: CPACK_WIX_EXTRA_SOURCES # -# Languages are compiled into the WixUI extension library. To use them, -# simply provide the name of the culture. If you specify more than one -# culture identifier in a comma or semicolon delimited list, the first -# one that is found will be used. You can find a list of supported -# languages at: -# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm +# Extra WiX source files # -# #end #variable CPACK_WIX_TEMPLATE - Template file for WiX generation +# This variable provides an optional list of extra WiX source files (.wxs) +# that should be compiled and linked. The full path to source files is +# required. # -# If this variable is set, the specified template will be used to -# generate the WiX wxs file. This should be used if further -# customization of the output is required. +# .. variable:: CPACK_WIX_EXTRA_OBJECTS # -# If this variable is not set, the default MSI template included with -# CMake will be used. +# Extra WiX object files or libraries # -# #end #variable CPACK_WIX_EXTRA_SOURCES - Extra WiX source files -# -# This variable provides an optional list of extra WiX source files -# (.wxs) that should be compiled and linked. The full path to source -# files is required. -# -# #end #variable CPACK_WIX_EXTRA_OBJECTS - Extra WiX object files or -# libraries -# -# This variable provides an optional list of extra WiX object (.wixobj) -# and/or WiX library (.wixlib) files. The full path to objects and -# libraries is required. -# -# #end +# This variable provides an optional list of extra WiX object (.wixobj) +# and/or WiX library (.wixlib) files. The full path to objects and libraries +# is required. #============================================================================= # Copyright 2012 Kitware, Inc. |