summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-10-30 13:04:52 (GMT)
committerBrad King <brad.king@kitware.com>2015-10-30 13:09:40 (GMT)
commit9a7f042a955e814f66b8e468f934852ed53e0376 (patch)
tree879cd3eecbab8fff28a4a13265767340f5cddc97 /Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
parent3187de20fd9949ab90df4651f5d1ae0d218a9afd (diff)
downloadCMake-9a7f042a955e814f66b8e468f934852ed53e0376.zip
CMake-9a7f042a955e814f66b8e468f934852ed53e0376.tar.gz
CMake-9a7f042a955e814f66b8e468f934852ed53e0376.tar.bz2
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.
Diffstat (limited to 'Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst')
-rw-r--r--Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst26
1 files changed, 14 insertions, 12 deletions
diff --git a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
index 729d929..548c3ac 100644
--- a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
+++ b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
@@ -1,25 +1,27 @@
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
-on Mac OS X. By default its Info.plist file is created by configuring
-a template called MacOSXFrameworkInfo.plist.in located in the
-CMAKE_MODULE_PATH. This property specifies an alternative template
+A library target with :prop_tgt:`FRAMEWORK` enabled will be built as a
+framework on Mac OS X. By default its ``Info.plist`` file is created by
+configuring a template called ``MacOSXFrameworkInfo.plist.in`` located in the
+:variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template
file name which may be a full path.
The following target properties may be set to specify content to be
configured into the file:
-::
-
- MACOSX_FRAMEWORK_ICON_FILE
- MACOSX_FRAMEWORK_IDENTIFIER
- MACOSX_FRAMEWORK_SHORT_VERSION_STRING
- MACOSX_FRAMEWORK_BUNDLE_VERSION
+``MACOSX_FRAMEWORK_BUNDLE_VERSION``
+ Sets ``CFBundleVersion``.
+``MACOSX_FRAMEWORK_ICON_FILE``
+ Sets ``CFBundleIconFile``.
+``MACOSX_FRAMEWORK_IDENTIFIER``
+ Sets ``CFBundleIdentifier``.
+``MACOSX_FRAMEWORK_SHORT_VERSION_STRING``
+ Sets ``CFBundleShortVersionString``.
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
-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.