summaryrefslogtreecommitdiffstats
path: root/Modules/FindLAPACK.cmake
diff options
context:
space:
mode:
authorMichael Hirsch, Ph.D <scivision@users.noreply.github.com>2019-01-29 19:31:01 (GMT)
committerBrad King <brad.king@kitware.com>2019-01-30 15:15:00 (GMT)
commitb323407235a3671eb11c7a039ce1c2f134025c73 (patch)
tree202bd57664ea33cd0c4dbed8d7a5d5f9a24fa444 /Modules/FindLAPACK.cmake
parentba30b94435bc621767fb887d081a257cdec8a633 (diff)
downloadCMake-b323407235a3671eb11c7a039ce1c2f134025c73.zip
CMake-b323407235a3671eb11c7a039ce1c2f134025c73.tar.gz
CMake-b323407235a3671eb11c7a039ce1c2f134025c73.tar.bz2
Find{BLAS,LAPACK}: Update docs to use modern conventions
Diffstat (limited to 'Modules/FindLAPACK.cmake')
-rw-r--r--Modules/FindLAPACK.cmake74
1 files changed, 45 insertions, 29 deletions
diff --git a/Modules/FindLAPACK.cmake b/Modules/FindLAPACK.cmake
index dbd943b..69eed9a 100644
--- a/Modules/FindLAPACK.cmake
+++ b/Modules/FindLAPACK.cmake
@@ -14,35 +14,51 @@ The approach follows that taken for the autoconf macro file,
acx_lapack.m4 (distributed at
http://ac-archive.sourceforge.net/ac-archive/acx_lapack.html).
-This module sets the following variables:
-
-::
-
- LAPACK_FOUND - set to true if a library implementing the LAPACK interface
- is found
- LAPACK_LINKER_FLAGS - uncached list of required linker flags (excluding -l
- and -L).
- LAPACK_LIBRARIES - uncached list of libraries (using full path name) to
- link against to use LAPACK
- LAPACK95_LIBRARIES - uncached list of libraries (using full path name) to
- link against to use LAPACK95
- LAPACK95_FOUND - set to true if a library implementing the LAPACK f95
- interface is found
- BLA_STATIC if set on this determines what kind of linkage we do (static)
- BLA_VENDOR if set checks only the specified vendor, if not set checks
- all the possibilities
- BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK
-
-List of vendors (BLA_VENDOR) valid in this module:
-
-* Intel(mkl)
-* OpenBLAS
-* FLAME
-* ACML
-* Apple
-* NAS
-* Generic
-
+Input Variables
+^^^^^^^^^^^^^^^
+
+The following variables may be set to influence this module's behavior:
+
+``BLA_STATIC``
+ if ``ON`` use static linkage
+
+``BLA_VENDOR``
+ If set, checks only the specified vendor, if not set checks all the
+ possibilities. List of vendors valid in this module:
+
+ * ``Intel10_32`` (intel mkl v10 32 bit)
+ * ``Intel10_64lp`` (intel mkl v10+ 64 bit, threaded code, lp64 model)
+ * ``Intel10_64lp_seq`` (intel mkl v10+ 64 bit, sequential code, lp64 model)
+ * ``Intel10_64ilp`` (intel mkl v10+ 64 bit, threaded code, ilp64 model)
+ * ``Intel10_64ilp_seq`` (intel mkl v10+ 64 bit, sequential code, ilp64 model)
+ * ``Intel`` (obsolete versions of mkl 32 and 64 bit)
+ * ``OpenBLAS``
+ * ``FLAME``
+ * ``ACML``
+ * ``Apple``
+ * ``NAS``
+ * ``Generic``
+
+``BLA_F95``
+ if ``ON`` tries to find BLAS95/LAPACK95
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+This module defines the following variables:
+
+``LAPACK_FOUND``
+ library implementing the LAPACK interface is found
+``LAPACK_LINKER_FLAGS``
+ uncached list of required linker flags (excluding -l and -L).
+``LAPACK_LIBRARIES``
+ uncached list of libraries (using full path name) to link against
+ to use LAPACK
+``LAPACK95_LIBRARIES``
+ uncached list of libraries (using full path name) to link against
+ to use LAPACK95
+``LAPACK95_FOUND``
+ library implementing the LAPACK95 interface is found
#]=======================================================================]
set(_lapack_ORIG_CMAKE_FIND_LIBRARY_SUFFIXES ${CMAKE_FIND_LIBRARY_SUFFIXES})