diff options
| author | Brad King <brad.king@kitware.com> | 2017-04-18 18:22:20 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2017-04-18 18:22:20 (GMT) |
| commit | 3022545f14a38d07105de0555c75e445c5b587a6 (patch) | |
| tree | 7e6c44bd11a5870f1e5eedb04f6b62c3d39d63f4 /Help | |
| parent | afc492d58f0af07d57256be3ac45ac70afecc256 (diff) | |
| download | CMake-3022545f14a38d07105de0555c75e445c5b587a6.zip CMake-3022545f14a38d07105de0555c75e445c5b587a6.tar.gz CMake-3022545f14a38d07105de0555c75e445c5b587a6.tar.bz2 | |
Help: Document find command search path separators
The `find_*` commands read search paths from both CMake variables
and from environment variables. Document how multiple values in
these variables should be separated.
Fixes: #16800
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/FIND_XXX.txt | 5 | ||||
| -rw-r--r-- | Help/command/find_package.rst | 5 |
2 files changed, 8 insertions, 2 deletions
diff --git a/Help/command/FIND_XXX.txt b/Help/command/FIND_XXX.txt index bd4d295..2f27764 100644 --- a/Help/command/FIND_XXX.txt +++ b/Help/command/FIND_XXX.txt @@ -73,6 +73,7 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: 1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a ``-DVAR=value``. + The values are interpreted as :ref:`;-lists <CMake Language Lists>`. This can be skipped if ``NO_CMAKE_PATH`` is passed. * |CMAKE_PREFIX_PATH_XXX| @@ -80,7 +81,9 @@ If ``NO_DEFAULT_PATH`` is not specified, the search process is as follows: * |CMAKE_XXX_MAC_PATH| 2. Search paths specified in cmake-specific environment variables. - These are intended to be set in the user's shell configuration. + These are intended to be set in the user's shell configuration, + and therefore use the host's native path separator + (``;`` on Windows and ``:`` on UNIX). This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed. * |CMAKE_PREFIX_PATH_XXX| diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 2cb1e5f..60a77b8 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -251,6 +251,7 @@ enabled. 1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a ``-DVAR=value``. + The values are interpreted as :ref:`;-lists <CMake Language Lists>`. This can be skipped if ``NO_CMAKE_PATH`` is passed:: CMAKE_PREFIX_PATH @@ -258,7 +259,9 @@ enabled. CMAKE_APPBUNDLE_PATH 2. Search paths specified in cmake-specific environment variables. - These are intended to be set in the user's shell configuration. + These are intended to be set in the user's shell configuration, + and therefore use the host's native path separator + (``;`` on Windows and ``:`` on UNIX). This can be skipped if ``NO_CMAKE_ENVIRONMENT_PATH`` is passed:: <package>_DIR |