diff options
| author | Brad King <brad.king@kitware.com> | 2015-07-15 13:05:44 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2015-07-15 13:05:44 (GMT) |
| commit | b2eff70f6b3a2abb5e5ce27a331717c319200a83 (patch) | |
| tree | 6e53786a3d9634ebda907d932430e67e50b9f029 /Help | |
| parent | 6cc660920d7aa40845a7309e3d799cd30cd657f8 (diff) | |
| parent | eb8eaaecbe4aaf950a217d53c477461794fe6db8 (diff) | |
| download | CMake-b2eff70f6b3a2abb5e5ce27a331717c319200a83.zip CMake-b2eff70f6b3a2abb5e5ce27a331717c319200a83.tar.gz CMake-b2eff70f6b3a2abb5e5ce27a331717c319200a83.tar.bz2 | |
Merge topic 'doc-apple-framework-creation'
eb8eaaec Help: Document Apple Framework creation with an example (#15651)
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/add_library.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake-buildsystem.7.rst | 16 | ||||
| -rw-r--r-- | Help/manual/cmake-properties.7.rst | 1 | ||||
| -rw-r--r-- | Help/prop_tgt/FRAMEWORK.rst | 4 | ||||
| -rw-r--r-- | Help/prop_tgt/FRAMEWORK_VERSION.rst | 5 |
5 files changed, 27 insertions, 1 deletions
diff --git a/Help/command/add_library.rst b/Help/command/add_library.rst index 7c06203..fe7735c 100644 --- a/Help/command/add_library.rst +++ b/Help/command/add_library.rst @@ -33,6 +33,8 @@ type is ``STATIC`` or ``SHARED`` based on whether the current value of the variable :variable:`BUILD_SHARED_LIBS` is ``ON``. For ``SHARED`` and ``MODULE`` libraries the :prop_tgt:`POSITION_INDEPENDENT_CODE` target property is set to ``ON`` automatically. +A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK` +target property to create an OS X Framework. By default the library file will be created in the build tree directory corresponding to the source tree directory in which the command was diff --git a/Help/manual/cmake-buildsystem.7.rst b/Help/manual/cmake-buildsystem.7.rst index aefdb71..357aae9 100644 --- a/Help/manual/cmake-buildsystem.7.rst +++ b/Help/manual/cmake-buildsystem.7.rst @@ -85,6 +85,22 @@ It is a type which is loaded as a plugin using runtime techniques. add_library(archive MODULE 7z.cpp) +.. _`Apple Frameworks`: + +Apple Frameworks +"""""""""""""""" + +A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK` +target property to create an OS X Framework: + +.. code-block:: cmake + + add_library(MyFramework SHARED MyFramework.cpp) + set_target_properties(MyFramework PROPERTIES + FRAMEWORK 1 + FRAMEWORK_VERSION A + ) + .. _`Object Libraries`: Object Libraries diff --git a/Help/manual/cmake-properties.7.rst b/Help/manual/cmake-properties.7.rst index b767ed6..9519046 100644 --- a/Help/manual/cmake-properties.7.rst +++ b/Help/manual/cmake-properties.7.rst @@ -135,6 +135,7 @@ Properties on Targets /prop_tgt/Fortran_FORMAT /prop_tgt/Fortran_MODULE_DIRECTORY /prop_tgt/FRAMEWORK + /prop_tgt/FRAMEWORK_VERSION /prop_tgt/GENERATOR_FILE_NAME /prop_tgt/GNUtoMS /prop_tgt/HAS_CXX diff --git a/Help/prop_tgt/FRAMEWORK.rst b/Help/prop_tgt/FRAMEWORK.rst index 9f472c0..dcb6d3b 100644 --- a/Help/prop_tgt/FRAMEWORK.rst +++ b/Help/prop_tgt/FRAMEWORK.rst @@ -6,4 +6,6 @@ This target is a framework on the Mac. 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 directory structure required for a framework and will be suitable to -be used with the -framework option +be used with the ``-framework`` option + +See also the :prop_tgt:`FRAMEWORK_VERSION` target property. diff --git a/Help/prop_tgt/FRAMEWORK_VERSION.rst b/Help/prop_tgt/FRAMEWORK_VERSION.rst new file mode 100644 index 0000000..bf650a7 --- /dev/null +++ b/Help/prop_tgt/FRAMEWORK_VERSION.rst @@ -0,0 +1,5 @@ +FRAMEWORK_VERSION +----------------- + +Version of a framework created using the :prop_tgt:`FRAMEWORK` target +property (e.g. ``A``). |