Help: Update documentation to reflect support for iOS

Many of our interfaces documented for OS X also work for iOS.

13 files changed, 67 insertions, 44 deletions

diff --git a/Help/prop_tgt/BUNDLE.rst b/Help/prop_tgt/BUNDLE.rst
index 166659f..075f017 100644
--- a/Help/prop_tgt/BUNDLE.rst
+++ b/Help/prop_tgt/BUNDLE.rst
@@ -1,9 +1,9 @@
 BUNDLE
 ------
 
-This target is a CFBundle on the Mac.
+This target is a ``CFBundle`` on the OS X.
 
 If a module library target has this property set to true it will be
-built as a CFBundle when built on the mac.  It will have the directory
-structure required for a CFBundle and will be suitable to be used for
+built as a ``CFBundle`` when built on the mac.  It will have the directory
+structure required for a ``CFBundle`` and will be suitable to be used for
 creating Browser Plugins or other application resources.
diff --git a/Help/prop_tgt/BUNDLE_EXTENSION.rst b/Help/prop_tgt/BUNDLE_EXTENSION.rst
index 94ac935..ea265b3 100644
--- a/Help/prop_tgt/BUNDLE_EXTENSION.rst
+++ b/Help/prop_tgt/BUNDLE_EXTENSION.rst
@@ -1,7 +1,7 @@
 BUNDLE_EXTENSION
 ----------------
 
-The file extension used to name a BUNDLE target on the Mac.
+The file extension used to name a :prop_tgt:`BUNDLE` target on the OS X and iOS.
 
-The default value is "bundle" - you can also use "plugin" or whatever
+The default value is ``bundle`` - you can also use ``plugin`` or whatever
 file extension is required by the host app for your bundle.
diff --git a/Help/prop_tgt/ENABLE_EXPORTS.rst b/Help/prop_tgt/ENABLE_EXPORTS.rst
index dfd4af7..9e22309 100644
--- a/Help/prop_tgt/ENABLE_EXPORTS.rst
+++ b/Help/prop_tgt/ENABLE_EXPORTS.rst
@@ -12,9 +12,9 @@ dependency on the executable is created for targets that link to it.
 For DLL platforms an import library will be created for the exported
 symbols and then used for linking.  All Windows-based systems
 including Cygwin are DLL platforms.  For non-DLL platforms that
-require all symbols to be resolved at link time, such as Mac OS X, the
+require all symbols to be resolved at link time, such as OS X, the
 module will "link" to the executable using a flag like
-"-bundle_loader".  For other non-DLL platforms the link rule is simply
+``-bundle_loader``.  For other non-DLL platforms the link rule is simply
 ignored since the dynamic loader will automatically bind symbols when
 the module is loaded.
 
diff --git a/Help/prop_tgt/FRAMEWORK.rst b/Help/prop_tgt/FRAMEWORK.rst
index dcb6d3b..6c212c3 100644
--- a/Help/prop_tgt/FRAMEWORK.rst
+++ b/Help/prop_tgt/FRAMEWORK.rst
@@ -1,11 +1,31 @@
 FRAMEWORK
 ---------
 
-This target is a framework on the Mac.
+Build ``SHARED`` library as Framework Bundle on the OS X and iOS.
 
-If a shared library target has this property set to true it will be
-built as a framework when built on the mac.  It will have the
+If a ``SHARED`` library target has this property set to ``TRUE`` it will be
+built as a framework when built on the OS X and iOS.  It will have the
 directory structure required for a framework and will be suitable to
 be used with the ``-framework`` option
 
-See also the :prop_tgt:`FRAMEWORK_VERSION` target property.
+To customize ``Info.plist`` file in the framework, use
+:prop_tgt:`MACOSX_FRAMEWORK_INFO_PLIST` target property.
+
+For OS X see also the :prop_tgt:`FRAMEWORK_VERSION` target property.
+
+Example of creation ``dynamicFramework``:
+
+.. code-block:: cmake
+
+  add_library(dynamicFramework SHARED
+              dynamicFramework.c
+              dynamicFramework.h
+  )
+  set_target_properties(dynamicFramework PROPERTIES
+    FRAMEWORK TRUE
+    FRAMEWORK_VERSION C
+    MACOSX_FRAMEWORK_IDENTIFIER com.cmake.dynamicFramework
+    MACOSX_FRAMEWORK_INFO_PLIST Info.plist
+    PUBLIC_HEADER dynamicFramework.h
+    XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer"
+  )
diff --git a/Help/prop_tgt/FRAMEWORK_VERSION.rst b/Help/prop_tgt/FRAMEWORK_VERSION.rst
index bf650a7..6aa3026 100644
--- a/Help/prop_tgt/FRAMEWORK_VERSION.rst
+++ b/Help/prop_tgt/FRAMEWORK_VERSION.rst
@@ -3,3 +3,6 @@ FRAMEWORK_VERSION
 
 Version of a framework created using the :prop_tgt:`FRAMEWORK` target
 property (e.g. ``A``).
+
+This property only affects OS X, as iOS doesn't have versioned
+directory structure.
diff --git a/Help/prop_tgt/MACOSX_BUNDLE.rst b/Help/prop_tgt/MACOSX_BUNDLE.rst
index ff21e61..8d7d914 100644
--- a/Help/prop_tgt/MACOSX_BUNDLE.rst
+++ b/Help/prop_tgt/MACOSX_BUNDLE.rst
@@ -1,12 +1,12 @@
 MACOSX_BUNDLE
 -------------
 
-Build an executable as an application bundle on Mac OS X.
+Build an executable as an Application Bundle on OS X or iOS.
 
-When this property is set to true the executable when built on Mac OS
-X will be created as an application bundle.  This makes it a GUI
-executable that can be launched from the Finder.  See the
-MACOSX_BUNDLE_INFO_PLIST target property for information about
-creation of the Info.plist file for the application bundle.  This
-property is initialized by the value of the variable
-CMAKE_MACOSX_BUNDLE if it is set when a target is created.
+When this property is set to true the executable when built on OS X
+or iOS will be created as an application bundle.  This makes it
+a GUI executable that can be launched from the Finder.  See the
+:prop_tgt:`MACOSX_FRAMEWORK_INFO_PLIST` target property for information about
+creation of the ``Info.plist`` file for the application bundle.
+This property is initialized by the value of the variable
+:variable:`CMAKE_MACOSX_BUNDLE` if it is set when a target is created.
diff --git a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst
index 07a933f..8515acc 100644
--- a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst
+++ b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst
@@ -1,10 +1,10 @@
 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 OS X and iOS Application Bundle.
 
 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
+application bundle on 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.
diff --git a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
index 548c3ac..58f31d4 100644
--- a/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
+++ b/Help/prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST.rst
@@ -1,10 +1,10 @@
 MACOSX_FRAMEWORK_INFO_PLIST
 ---------------------------
 
-Specify a custom ``Info.plist`` template for a Mac OS X Framework.
+Specify a custom ``Info.plist`` template for a OS X and iOS Framework.
 
 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
+framework on 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.
diff --git a/Help/prop_tgt/MACOSX_RPATH.rst b/Help/prop_tgt/MACOSX_RPATH.rst
index 1c503d1..41bb8cc 100644
--- a/Help/prop_tgt/MACOSX_RPATH.rst
+++ b/Help/prop_tgt/MACOSX_RPATH.rst
@@ -1,7 +1,7 @@
 MACOSX_RPATH
 ------------
 
-Whether this target on Mac OS X is located at runtime using rpaths.
+Whether this target on OS X or iOS is located at runtime using rpaths.
 
 When this property is set to true, the directory portion of
 the "install_name" field of this shared library will be ``@rpath``
@@ -17,7 +17,7 @@ Runtime paths will also be embedded in binaries using this target and
 can be controlled by the :prop_tgt:`INSTALL_RPATH` target property on
 the target linking to this target.
 
-Policy CMP0042 was introduced to change the default value of
-MACOSX_RPATH to ON.  This is because use of ``@rpath`` is a
+Policy :policy:`CMP0042` was introduced to change the default value of
+``MACOSX_RPATH`` to ``TRUE.  This is because use of ``@rpath`` is a
 more flexible and powerful alternative to ``@executable_path`` and
 ``@loader_path``.
diff --git a/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst
index f8fdcff..fb78177 100644
--- a/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst
+++ b/Help/prop_tgt/OSX_ARCHITECTURES_CONFIG.rst
@@ -1,7 +1,7 @@
 OSX_ARCHITECTURES_<CONFIG>
 --------------------------
 
-Per-configuration OS X binary architectures for a target.
+Per-configuration OS X and iOS binary architectures for a target.
 
 This property is the configuration-specific version of
 :prop_tgt:`OSX_ARCHITECTURES`.
diff --git a/Help/prop_tgt/PRIVATE_HEADER.rst b/Help/prop_tgt/PRIVATE_HEADER.rst
index da2127b..c4412ed 100644
--- a/Help/prop_tgt/PRIVATE_HEADER.rst
+++ b/Help/prop_tgt/PRIVATE_HEADER.rst
@@ -1,11 +1,11 @@
 PRIVATE_HEADER
 --------------
 
-Specify private header files in a FRAMEWORK shared library target.
+Specify private header files in a :prop_tgt:`FRAMEWORK` shared library target.
 
-Shared library targets marked with the FRAMEWORK property generate
-frameworks on OS X and normal shared libraries on other platforms.
+Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate
+frameworks on OS X, iOS and normal shared libraries on other platforms.
 This property may be set to a list of header files to be placed in the
 PrivateHeaders directory inside the framework folder.  On non-Apple
-platforms these headers may be installed using the PRIVATE_HEADER
-option to the install(TARGETS) command.
+platforms these headers may be installed using the ``PRIVATE_HEADER``
+option to the ``install(TARGETS)`` command.
diff --git a/Help/prop_tgt/PUBLIC_HEADER.rst b/Help/prop_tgt/PUBLIC_HEADER.rst
index 6e25d94..d4a636c 100644
--- a/Help/prop_tgt/PUBLIC_HEADER.rst
+++ b/Help/prop_tgt/PUBLIC_HEADER.rst
@@ -1,11 +1,11 @@
 PUBLIC_HEADER
 -------------
 
-Specify public header files in a FRAMEWORK shared library target.
+Specify public header files in a :prop_tgt:`FRAMEWORK` shared library target.
 
-Shared library targets marked with the FRAMEWORK property generate
-frameworks on OS X and normal shared libraries on other platforms.
+Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate
+frameworks on OS X, iOS and normal shared libraries on other platforms.
 This property may be set to a list of header files to be placed in the
-Headers directory inside the framework folder.  On non-Apple platforms
-these headers may be installed using the PUBLIC_HEADER option to the
-install(TARGETS) command.
+``Headers`` directory inside the framework folder.  On non-Apple platforms
+these headers may be installed using the ``PUBLIC_HEADER`` option to the
+``install(TARGETS)`` command.
diff --git a/Help/prop_tgt/RESOURCE.rst b/Help/prop_tgt/RESOURCE.rst
index 1e9921d..5dad3ea 100644
--- a/Help/prop_tgt/RESOURCE.rst
+++ b/Help/prop_tgt/RESOURCE.rst
@@ -1,11 +1,11 @@
 RESOURCE
 --------
 
-Specify resource files in a FRAMEWORK shared library target.
+Specify resource files in a :prop_tgt:`FRAMEWORK` shared library target.
 
-Shared library targets marked with the FRAMEWORK property generate
-frameworks on OS X and normal shared libraries on other platforms.
+Shared library targets marked with the :prop_tgt:`FRAMEWORK` property generate
+frameworks on OS X, iOS and normal shared libraries on other platforms.
 This property may be set to a list of files to be placed in the
-Resources directory inside the framework folder.  On non-Apple
-platforms these files may be installed using the RESOURCE option to
-the install(TARGETS) command.
+``Resources`` directory inside the framework folder.  On non-Apple
+platforms these files may be installed using the ``RESOURCE`` option to
+the ``install(TARGETS)`` command.