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

Help: Document target properties setting Info.plist fields (#15820) 

Format the documentation of MACOSX_{BUNDLE,FRAMEWORK}_INFO_PLIST and
specify for each property what field in the Info.plist file it sets.
This commit is contained in:
Brad King 2015-10-30 09:04:52 -04:00
parent 3187de20fd
commit 9a7f042a95
2 changed files with 37 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst
View File

@ -1,29 +1,35 @@
MACOSX_BUNDLE_INFO_PLIST MACOSX_BUNDLE_INFO_PLIST
------------------------ ------------------------
Specify a custom Info.plist template for a Mac OS X App Bundle. Specify a custom ``Info.plist`` template for a Mac OS X App Bundle.
An executable target with MACOSX_BUNDLE enabled will be built as an An executable target with :prop_tgt:`MACOSX_BUNDLE` enabled will be built as an
application bundle on Mac OS X. By default its Info.plist file is application bundle on Mac OS X. By default its ``Info.plist`` file is created
created by configuring a template called MacOSXBundleInfo.plist.in by configuring a template called ``MacOSXBundleInfo.plist.in`` located in the
located in the CMAKE_MODULE_PATH. This property specifies an :variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template
alternative template file name which may be a full path. file name which may be a full path.
The following target properties may be set to specify content to be The following target properties may be set to specify content to be
configured into the file: configured into the file:
:: ``MACOSX_BUNDLE_BUNDLE_NAME``
Sets ``CFBundleName``.
MACOSX_BUNDLE_INFO_STRING ``MACOSX_BUNDLE_BUNDLE_VERSION``
MACOSX_BUNDLE_ICON_FILE Sets ``CFBundleVersion``.
MACOSX_BUNDLE_GUI_IDENTIFIER ``MACOSX_BUNDLE_COPYRIGHT``
MACOSX_BUNDLE_LONG_VERSION_STRING Sets ``NSHumanReadableCopyright``.
MACOSX_BUNDLE_BUNDLE_NAME ``MACOSX_BUNDLE_GUI_IDENTIFIER``
MACOSX_BUNDLE_SHORT_VERSION_STRING Sets ``CFBundleIdentifier``.
MACOSX_BUNDLE_BUNDLE_VERSION ``MACOSX_BUNDLE_ICON_FILE``
MACOSX_BUNDLE_COPYRIGHT Sets ``CFBundleIconFile``.
``MACOSX_BUNDLE_INFO_STRING``
Sets ``CFBundleGetInfoString``.
``MACOSX_BUNDLE_LONG_VERSION_STRING``
Sets ``CFBundleLongVersionString``.
``MACOSX_BUNDLE_SHORT_VERSION_STRING``
Sets ``CFBundleShortVersionString``.
CMake variables of the same name may be set to affect all targets in a CMake variables of the same name may be set to affect all targets in a
directory that do not have each specific property set. If a custom directory that do not have each specific property set. If a custom
Info.plist is specified by this property it may of course hard-code ``Info.plist`` is specified by this property it may of course hard-code
all the settings instead of using the target properties. all the settings instead of using the target properties.

26
Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
View File

@ -1,25 +1,27 @@
MACOSX_FRAMEWORK_INFO_PLIST MACOSX_FRAMEWORK_INFO_PLIST
--------------------------- ---------------------------
Specify a custom Info.plist template for a Mac OS X Framework. Specify a custom ``Info.plist`` template for a Mac OS X Framework.
A library target with FRAMEWORK enabled will be built as a framework A library target with :prop_tgt:`FRAMEWORK` enabled will be built as a
on Mac OS X. By default its Info.plist file is created by configuring framework on Mac OS X. By default its ``Info.plist`` file is created by
a template called MacOSXFrameworkInfo.plist.in located in the configuring a template called ``MacOSXFrameworkInfo.plist.in`` located in the
CMAKE_MODULE_PATH. This property specifies an alternative template :variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template
file name which may be a full path. file name which may be a full path.
The following target properties may be set to specify content to be The following target properties may be set to specify content to be
configured into the file: configured into the file:
:: ``MACOSX_FRAMEWORK_BUNDLE_VERSION``
Sets ``CFBundleVersion``.
MACOSX_FRAMEWORK_ICON_FILE ``MACOSX_FRAMEWORK_ICON_FILE``
MACOSX_FRAMEWORK_IDENTIFIER Sets ``CFBundleIconFile``.
MACOSX_FRAMEWORK_SHORT_VERSION_STRING ``MACOSX_FRAMEWORK_IDENTIFIER``
MACOSX_FRAMEWORK_BUNDLE_VERSION Sets ``CFBundleIdentifier``.
``MACOSX_FRAMEWORK_SHORT_VERSION_STRING``
Sets ``CFBundleShortVersionString``.
CMake variables of the same name may be set to affect all targets in a CMake variables of the same name may be set to affect all targets in a
directory that do not have each specific property set. If a custom directory that do not have each specific property set. If a custom
Info.plist is specified by this property it may of course hard-code ``Info.plist`` is specified by this property it may of course hard-code
all the settings instead of using the target properties. all the settings instead of using the target properties.