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/CPackBundle.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/CPackBundle.cmake')
| -rw-r--r-- | Modules/CPackBundle.cmake | 52 |
1 files changed, 18 insertions, 34 deletions
diff --git a/Modules/CPackBundle.cmake b/Modules/CPackBundle.cmake index 00c5fc2..d8293c0 100644 --- a/Modules/CPackBundle.cmake +++ b/Modules/CPackBundle.cmake @@ -4,51 +4,35 @@ # # CPack Bundle generator (Mac OS X) specific options # -# #section Variables specific to CPack Bundle generator #end #module +# Variables specific to CPack Bundle generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # # Installers built on Mac OS X using the Bundle generator use the # aforementioned DragNDrop (CPACK_DMG_xxx) variables, plus the following -# Bundle-specific parameters (CPACK_BUNDLE_xxx). #end +# Bundle-specific parameters (CPACK_BUNDLE_xxx). # -# #variable +# .. variable:: CPACK_BUNDLE_NAME # -# :: +# The name of the generated bundle. This appears in the OSX finder as the +# bundle name. Required. # -# CPACK_BUNDLE_NAME - The name of the generated bundle. This -# appears in the OSX finder as the bundle name. Required. +# .. variable:: CPACK_BUNDLE_PLIST # -# #end +# Path to an OSX plist file that will be used for the generated bundle. This +# assumes that the caller has generated or specified their own Info.plist +# file. Required. # -# #variable +# .. variable:: CPACK_BUNDLE_ICON # -# :: +# Path to an OSX icon file that will be used as the icon for the generated +# bundle. This is the icon that appears in the OSX finder for the bundle, and +# in the OSX dock when the bundle is opened. Required. # -# CPACK_BUNDLE_PLIST - Path to an OSX plist file that will be used -# for the generated bundle. This assumes that the caller has generated -# or specified their own Info.plist file. Required. +# .. variable:: CPACK_BUNDLE_STARTUP_COMMAND # -# #end -# -# #variable -# -# :: -# -# CPACK_BUNDLE_ICON - Path to an OSX icon file that will be used as -# the icon for the generated bundle. This is the icon that appears in the -# OSX finder for the bundle, and in the OSX dock when the bundle is opened. -# Required. -# -# #end -# -# #variable -# -# :: -# -# CPACK_BUNDLE_STARTUP_COMMAND - Path to a startup script. This is a path to -# an executable or script that will be run whenever an end-user double-clicks -# the generated bundle in the OSX Finder. Optional. -# -# #end +# Path to a startup script. This is a path to an executable or script that +# will be run whenever an end-user double-clicks the generated bundle in the +# OSX Finder. Optional. #============================================================================= # Copyright 2006-2009 Kitware, Inc. |