Help: Document CMAKE_FIND_APPBUNDLE and CMAKE_FIND_FRAMEWORK

Add dedicated documents for these and link to them instead of
duplicating their documentation in every find command.
This commit is contained in:
Brad King 2015-06-08 15:36:31 -04:00
parent 25b4483ef8
commit 8c64c4783d
6 changed files with 53 additions and 29 deletions

View File

@ -100,6 +100,9 @@ If NO_DEFAULT_PATH is not specified, the search process is as follows:
.. |FIND_ARGS_XXX| replace:: <VAR> NAMES name .. |FIND_ARGS_XXX| replace:: <VAR> NAMES name
.. include:: FIND_XXX_MAC.txt On OS X the :variable:`CMAKE_FIND_FRAMEWORK` and
:variable:`CMAKE_FIND_APPBUNDLE` variables determine the order of
preference between Apple-style and unix-style package components.
.. include:: FIND_XXX_ROOT.txt .. include:: FIND_XXX_ROOT.txt
.. include:: FIND_XXX_ORDER.txt .. include:: FIND_XXX_ORDER.txt

View File

@ -1,24 +0,0 @@
On Darwin or systems supporting OS X Frameworks, the cmake variable
CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:
* FIRST: Try to find frameworks before standard libraries or headers.
This is the default on Darwin.
* LAST: Try to find frameworks after standard libraries or headers.
* ONLY: Only try to find frameworks.
* NEVER: Never try to find frameworks.
On Darwin or systems supporting OS X Application Bundles, the cmake
variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the
following:
* FIRST: Try to find application bundles before standard programs.
This is the default on Darwin.
* LAST: Try to find application bundles after standard programs.
* ONLY: Only try to find application bundles.
* NEVER: Never try to find application bundles.

View File

@ -228,9 +228,9 @@ installation directory. Those marked with (U) are intended for
installations on UNIX platforms where the prefix is shared by multiple installations on UNIX platforms where the prefix is shared by multiple
packages. This is merely a convention, so all (W) and (U) directories packages. This is merely a convention, so all (W) and (U) directories
are still searched on all platforms. Directories marked with (A) are are still searched on all platforms. Directories marked with (A) are
intended for installations on Apple platforms. The cmake variables intended for installations on Apple platforms. The
``CMAKE_FIND_FRAMEWORK`` and ``CMAKE_FIND_APPBUNDLE`` :variable:`CMAKE_FIND_FRAMEWORK` and :variable:`CMAKE_FIND_APPBUNDLE`
determine the order of preference as specified below. variables determine the order of preference.
The set of installation prefixes is constructed using the following The set of installation prefixes is constructed using the following
steps. If ``NO_DEFAULT_PATH`` is specified all ``NO_*`` options are steps. If ``NO_DEFAULT_PATH`` is specified all ``NO_*`` options are
@ -295,7 +295,6 @@ enabled.
.. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace:: .. |CMAKE_FIND_ROOT_PATH_MODE_XXX| replace::
:variable:`CMAKE_FIND_ROOT_PATH_MODE_PACKAGE` :variable:`CMAKE_FIND_ROOT_PATH_MODE_PACKAGE`
.. include:: FIND_XXX_MAC.txt
.. include:: FIND_XXX_ROOT.txt .. include:: FIND_XXX_ROOT.txt
.. include:: FIND_XXX_ORDER.txt .. include:: FIND_XXX_ORDER.txt

View File

@ -117,6 +117,8 @@ Variables that Change Behavior
/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION /variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION
/variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY /variable/CMAKE_EXPORT_NO_PACKAGE_REGISTRY
/variable/CMAKE_SYSROOT /variable/CMAKE_SYSROOT
/variable/CMAKE_FIND_APPBUNDLE
/variable/CMAKE_FIND_FRAMEWORK
/variable/CMAKE_FIND_LIBRARY_PREFIXES /variable/CMAKE_FIND_LIBRARY_PREFIXES
/variable/CMAKE_FIND_LIBRARY_SUFFIXES /variable/CMAKE_FIND_LIBRARY_SUFFIXES
/variable/CMAKE_FIND_NO_INSTALL_PREFIX /variable/CMAKE_FIND_NO_INSTALL_PREFIX

View File

@ -0,0 +1,22 @@
CMAKE_FIND_APPBUNDLE
--------------------
This variable affects how ``find_*`` commands choose between
OS X Application Bundles and unix-style package components.
On Darwin or systems supporting OS X Application Bundles, the
``CMAKE_FIND_APPBUNDLE`` variable can be set to empty or
one of the following:
``FIRST``
Try to find application bundles before standard programs.
This is the default on Darwin.
``LAST``
Try to find application bundles after standard programs.
``ONLY``
Only try to find application bundles.
``NEVER``
Never try to find application bundles.

View File

@ -0,0 +1,22 @@
CMAKE_FIND_FRAMEWORK
--------------------
This variable affects how ``find_*`` commands choose between
OS X Frameworks and unix-style package components.
On Darwin or systems supporting OS X Frameworks, the
``CMAKE_FIND_FRAMEWORK`` variable can be set to empty or
one of the following:
``FIRST``
Try to find frameworks before standard libraries or headers.
This is the default on Darwin.
``LAST``
Try to find frameworks after standard libraries or headers.
``ONLY``
Only try to find frameworks.
``NEVER``
Never try to find frameworks.