diff options
author | 權少 <ljqican@163.com> | 2023-10-29 04:53:34 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2023-10-30 12:53:24 (GMT) |
commit | bc1f0f6e0f63cf5710eb8d651421ae01155ed9d0 (patch) | |
tree | edf3e4f9a054b730b8d96cd11f063fa8def3e067 /Modules/FindOpenThreads.cmake | |
parent | 76c08300cad284f281634b7252c44bb3e2f3171c (diff) | |
download | CMake-bc1f0f6e0f63cf5710eb8d651421ae01155ed9d0.zip CMake-bc1f0f6e0f63cf5710eb8d651421ae01155ed9d0.tar.gz CMake-bc1f0f6e0f63cf5710eb8d651421ae01155ed9d0.tar.bz2 |
FindOpenThreads: Update documentation
Diffstat (limited to 'Modules/FindOpenThreads.cmake')
-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 |