mirror of
https://github.com/Kitware/CMake.git
synced 2025-12-31 10:50:16 -06:00
Help: Fix markup errors, improve wording of CMAKE_FIND... variable docs
This commit is contained in:
Craig Scott
@@ -75,28 +75,27 @@ Commands
|
||||
|
||||
* The :command:`find_file`, :command:`find_library`, :command:`find_path`,
|
||||
:command:`find_package`, and :command:`find_program` commands have learned to
|
||||
check the following variables to control searching
|
||||
check the following variables to control the default behavior for groups of
|
||||
search locations:
|
||||
|
||||
* :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` - Controls the searching
|
||||
the cmake-specific environment variables.
|
||||
* :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` - Controls the default
|
||||
behavior of searching the :variable:`<PackageName>_ROOT` variables.
|
||||
|
||||
* :variable:`CMAKE_FIND_USE_CMAKE_PATH` - Controls the searching the
|
||||
cmake-specific cache variables.
|
||||
* :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH` - Controls the default
|
||||
behavior of searching the CMake-specific environment variables.
|
||||
|
||||
* :variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` - Controls the searching
|
||||
cmake platform specific variables.
|
||||
* :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` - Controls the default
|
||||
behavior of searching the standard system environment variables.
|
||||
|
||||
* :variable:`CMAKE_FIND_USE_PACKAGE_ROOT_PATH` - Controls the searching of
|
||||
:variable:`<PackageName>_ROOT` variables.
|
||||
* :variable:`CMAKE_FIND_USE_CMAKE_PATH` - Controls the default behavior of
|
||||
searching the CMake-specific cache variables.
|
||||
|
||||
* :variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH` - Controls the searching
|
||||
the standard system environment variables.
|
||||
* :variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH` - Controls the default
|
||||
behavior of searching the platform-specific CMake variables.
|
||||
|
||||
* The :command:`find_package` command has learned to check the following
|
||||
variables to control searching
|
||||
|
||||
* :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` - Controls the searching the
|
||||
cmake user registry.
|
||||
* The :command:`find_package` command has learned to check the
|
||||
:variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` variable to control the default
|
||||
behavior of searching the CMake user package registry.
|
||||
|
||||
* The :command:`message` command learned indentation control with the new
|
||||
:variable:`CMAKE_MESSAGE_INDENT` variable.
|
||||
|
||||
@@ -8,8 +8,8 @@ CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY
|
||||
By default this variable is not set. If neither
|
||||
:variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` nor
|
||||
``CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`` is set, then
|
||||
:command:`find_package()` will use the `User Package Registry` unless the
|
||||
`NO_CMAKE_PACKAGE_REGISTRY` option is provided.
|
||||
:command:`find_package()` will use the :ref:`User Package Registry`
|
||||
unless the ``NO_CMAKE_PACKAGE_REGISTRY`` option is provided.
|
||||
|
||||
``CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`` is ignored if
|
||||
:variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY` is set.
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH
|
||||
-------------------------------------
|
||||
|
||||
Controls the searching the cmake-specific environment variables by the
|
||||
:command:`find_program`, :command:`find_library`, :command:`find_file`,
|
||||
:command:`find_path`, and command:`find_package` commands.
|
||||
Controls the default behavior of the following commands for whether or not to
|
||||
search paths provided by cmake-specific environment variables:
|
||||
|
||||
* :command:`find_program`
|
||||
* :command:`find_library`
|
||||
* :command:`find_file`
|
||||
* :command:`find_path`
|
||||
* :command:`find_package`
|
||||
|
||||
This is useful in cross-compiling environments.
|
||||
|
||||
By default this variable is not set, which is equivalent to it having
|
||||
a value of ``TRUE``. Explicit options given to the :command:`find_program`,
|
||||
:command:`find_library`, :command:`find_file`, and :command:`find_path`
|
||||
commands take precedence over this variable.
|
||||
a value of ``TRUE``. Explicit options given to the above commands
|
||||
take precedence over this variable.
|
||||
|
||||
See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH`,
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
CMAKE_FIND_USE_CMAKE_PATH
|
||||
-------------------------
|
||||
|
||||
Controls the searching the cmake-specific cache variables by the
|
||||
:command:`find_program`, :command:`find_library`, :command:`find_file`,
|
||||
:command:`find_path`, and command:`find_package` commands.
|
||||
Controls the default behavior of the following commands for whether or not to
|
||||
search paths provided by cmake-specific cache variables:
|
||||
|
||||
* :command:`find_program`
|
||||
* :command:`find_library`
|
||||
* :command:`find_file`
|
||||
* :command:`find_path`
|
||||
* :command:`find_package`
|
||||
|
||||
This is useful in cross-compiling environments.
|
||||
|
||||
By default this variable is not set, which is equivalent to it having
|
||||
a value of ``TRUE``. Explicit options given to the :command:`find_program`,
|
||||
:command:`find_library`, :command:`find_file`, and :command:`find_path`
|
||||
commands take precedence over this variable.
|
||||
a value of ``TRUE``. Explicit options given to the above commands
|
||||
take precedence over this variable.
|
||||
|
||||
See also the :variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH`,
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
CMAKE_FIND_USE_CMAKE_SYSTEM_PATH
|
||||
--------------------------------
|
||||
|
||||
Controls the searching cmake platform specific variables by the
|
||||
:command:`find_program`, :command:`find_library`, :command:`find_file`,
|
||||
:command:`find_path`, and command:`find_package` commands.
|
||||
Controls the default behavior of the following commands for whether or not to
|
||||
search paths provided by platform-specific cmake variables:
|
||||
|
||||
* :command:`find_program`
|
||||
* :command:`find_library`
|
||||
* :command:`find_file`
|
||||
* :command:`find_path`
|
||||
* :command:`find_package`
|
||||
|
||||
This is useful in cross-compiling environments.
|
||||
|
||||
By default this variable is not set, which is equivalent to it having
|
||||
a value of ``TRUE``. Explicit options given to the :command:`find_program`,
|
||||
:command:`find_library`, :command:`find_file`, and :command:`find_path`
|
||||
commands take precedence over this variable.
|
||||
a value of ``TRUE``. Explicit options given to the above commands
|
||||
take precedence over this variable.
|
||||
|
||||
See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`,
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
CMAKE_FIND_USE_PACKAGE_REGISTRY
|
||||
-------------------------------
|
||||
|
||||
Controls the searching the :ref:`User Package Registry` by the :command:`find_package`
|
||||
command.
|
||||
Controls the default behavior of the :command:`find_package` command for
|
||||
whether or not to search paths provided by the :ref:`User Package Registry`.
|
||||
|
||||
By default this variable is not set and the behavior will fall back
|
||||
to that determined by the deprecated :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`
|
||||
variable. If that is also not set, then `find_package()` will use the
|
||||
`User Package Registry` unless the `NO_CMAKE_PACKAGE_REGISTRY` option
|
||||
to that determined by the deprecated
|
||||
:variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` variable. If that is
|
||||
also not set, then :command:`find_package` will use the
|
||||
:ref:`User Package Registry` unless the ``NO_CMAKE_PACKAGE_REGISTRY`` option
|
||||
is provided.
|
||||
|
||||
This variable takes precedence over :variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY`
|
||||
when both are set.
|
||||
This variable takes precedence over
|
||||
:variable:`CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY` when both are set.
|
||||
|
||||
In some cases, for example to locate only system wide installations, it
|
||||
is not desirable to use the :ref:`User Package Registry` when searching
|
||||
for packages. If the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY`
|
||||
for packages. If the :variable:`CMAKE_FIND_USE_PACKAGE_REGISTRY`
|
||||
variable is ``FALSE``, all the :command:`find_package` commands will skip
|
||||
the :ref:`User Package Registry` as if they were called with the
|
||||
``NO_CMAKE_PACKAGE_REGISTRY`` argument.
|
||||
|
||||
See also :ref:`Disabling the Package Registry`.
|
||||
|
||||
See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
||||
See also :ref:`Disabling the Package Registry` and the
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_SYSTEM_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH`,
|
||||
|
||||
@@ -1,15 +1,18 @@
|
||||
CMAKE_FIND_USE_PACKAGE_ROOT_PATH
|
||||
--------------------------------
|
||||
|
||||
Controls the searching of :variable:`<PackageName>_ROOT` variables by the
|
||||
:command:`find_program`, :command:`find_library`, :command:`find_file`,
|
||||
:command:`find_path`, and command:`find_package` commands.
|
||||
This is useful in cross-compiling environments.
|
||||
Controls the default behavior of the following commands for whether or not to
|
||||
search paths provided by :variable:`<PackageName>_ROOT` variables:
|
||||
|
||||
* :command:`find_program`
|
||||
* :command:`find_library`
|
||||
* :command:`find_file`
|
||||
* :command:`find_path`
|
||||
* :command:`find_package`
|
||||
|
||||
By default this variable is not set, which is equivalent to it having
|
||||
a value of ``TRUE``. Explicit options given to the :command:`find_program`,
|
||||
:command:`find_library`, :command:`find_file`, and :command:`find_path`
|
||||
commands take precedence over this variable.
|
||||
a value of ``TRUE``. Explicit options given to the above commands
|
||||
take precedence over this variable.
|
||||
|
||||
See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`,
|
||||
|
||||
@@ -1,15 +1,20 @@
|
||||
CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH
|
||||
--------------------------------------
|
||||
|
||||
Controls the searching the standard system environment variables by the
|
||||
:command:`find_program`, :command:`find_library`, :command:`find_file`,
|
||||
:command:`find_path`, and command:`find_package` commands.
|
||||
Controls the default behavior of the following commands for whether or not to
|
||||
search paths provided by standard system environment variables:
|
||||
|
||||
* :command:`find_program`
|
||||
* :command:`find_library`
|
||||
* :command:`find_file`
|
||||
* :command:`find_path`
|
||||
* :command:`find_package`
|
||||
|
||||
This is useful in cross-compiling environments.
|
||||
|
||||
By default this variable is not set, which is equivalent to it having
|
||||
a value of ``TRUE``. Explicit options given to the :command:`find_program`,
|
||||
:command:`find_library`, :command:`find_file`, and :command:`find_path`
|
||||
commands take precedence over this variable.
|
||||
a value of ``TRUE``. Explicit options given to the above commands
|
||||
take precedence over this variable.
|
||||
|
||||
See also the :variable:`CMAKE_FIND_USE_CMAKE_PATH`,
|
||||
:variable:`CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH`,
|
||||
|
||||
Reference in New Issue
Block a user