diff options
| author | Brad King <brad.king@kitware.com> | 2023-10-30 18:21:48 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2023-10-30 18:22:01 (GMT) |
| commit | 4ca40374d66583b241689c756b7438b6eaa42975 (patch) | |
| tree | 2f20937542cf70836030c0ef4a0a40b6a4afb3ef /Modules | |
| parent | 8e77c6e8ae497632fd39c4b3da1965215eb6a568 (diff) | |
| parent | bc1f0f6e0f63cf5710eb8d651421ae01155ed9d0 (diff) | |
| download | CMake-4ca40374d66583b241689c756b7438b6eaa42975.zip CMake-4ca40374d66583b241689c756b7438b6eaa42975.tar.gz CMake-4ca40374d66583b241689c756b7438b6eaa42975.tar.bz2 | |
Merge topic 'FindOpenThreads-doc'
bc1f0f6e0f FindOpenThreads: Update documentation
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8929
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/FindOpenThreads.cmake | 30 |
1 files changed, 18 insertions, 12 deletions
diff --git a/Modules/FindOpenThreads.cmake b/Modules/FindOpenThreads.cmake index bc45eea..6be3422 100644 --- a/Modules/FindOpenThreads.cmake +++ b/Modules/FindOpenThreads.cmake @@ -5,26 +5,32 @@ FindOpenThreads --------------- - - OpenThreads is a C++ based threading library. Its largest userbase seems to OpenSceneGraph so you might notice I accept OSGDIR as an -environment path. I consider this part of the Findosg* suite used to +environment path. I consider this part of the ``Findosg*`` suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. -Locate OpenThreads This module defines OPENTHREADS_LIBRARY -OPENTHREADS_FOUND, if false, do not try to link to OpenThreads -OPENTHREADS_INCLUDE_DIR, where to find the headers +This module defines: + +``OPENTHREADS_LIBRARY`` + +``OPENTHREADS_FOUND`` + if false, do not try to link to OpenThreads +``OPENTHREADS_INCLUDE_DIR`` + where to find the headers + +``$OPENTHREADS_DIR`` is an environment variable that would correspond to the:: + + ./configure --prefix=$OPENTHREADS_DIR -$OPENTHREADS_DIR is an environment variable that would correspond to -the ./configure --prefix=$OPENTHREADS_DIR used in building osg. +used in building osg. -[CMake 2.8.10]: The CMake variables OPENTHREADS_DIR or OSG_DIR can now -be used as well to influence detection, instead of needing to specify -an environment variable. +.. versionadded:: 2.8.10 -Created by Eric Wing. + The CMake variables ``OPENTHREADS_DIR`` or ``OSG_DIR`` can now + be used as well to influence detection, instead of needing to specify + an environment variable. #]=======================================================================] # Header files are presumed to be included like |