From 9a7f042a955e814f66b8e468f934852ed53e0376 Mon Sep 17 00:00:00 2001 From: Brad King Date: Fri, 30 Oct 2015 09:04:52 -0400 Subject: [PATCH] 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. --- Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst | 40 +++++++++++-------- Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst | 26 ++++++------ 2 files changed, 37 insertions(+), 29 deletions(-) diff --git a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst index 097cce186..07a933faf 100644 --- a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst +++ b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst @@ -1,29 +1,35 @@ 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 -application bundle on Mac OS X. By default its Info.plist file is -created by configuring a template called MacOSXBundleInfo.plist.in -located in the CMAKE_MODULE_PATH. This property specifies an -alternative template file name which may be a full path. +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 created +by configuring a template called ``MacOSXBundleInfo.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_BUNDLE_INFO_STRING - MACOSX_BUNDLE_ICON_FILE - MACOSX_BUNDLE_GUI_IDENTIFIER - MACOSX_BUNDLE_LONG_VERSION_STRING - MACOSX_BUNDLE_BUNDLE_NAME - MACOSX_BUNDLE_SHORT_VERSION_STRING - MACOSX_BUNDLE_BUNDLE_VERSION - MACOSX_BUNDLE_COPYRIGHT +``MACOSX_BUNDLE_BUNDLE_NAME`` + Sets ``CFBundleName``. +``MACOSX_BUNDLE_BUNDLE_VERSION`` + Sets ``CFBundleVersion``. +``MACOSX_BUNDLE_COPYRIGHT`` + Sets ``NSHumanReadableCopyright``. +``MACOSX_BUNDLE_GUI_IDENTIFIER`` + Sets ``CFBundleIdentifier``. +``MACOSX_BUNDLE_ICON_FILE`` + 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 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. diff --git a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst index 729d92902..548c3ac64 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.