Merge topic 'lapack-docs'

be7b30f67e Find{BLAS,LAPACK}: Add note and example for using Intel MKL
b323407235 Find{BLAS,LAPACK}: Update docs to use modern conventions
ba30b94435 FindLAPACK: Remove extra indentation from a line

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2880

1 files changed, 66 insertions, 52 deletions

diff --git a/Modules/FindBLAS.cmake b/Modules/FindBLAS.cmake
index 33cc024..0aa4f50 100644
--- a/Modules/FindBLAS.cmake
+++ b/Modules/FindBLAS.cmake
@@ -13,62 +13,76 @@ list of libraries searched for is taken from the autoconf macro file,
 acx_blas.m4 (distributed at
 http://ac-archive.sourceforge.net/ac-archive/acx_blas.html).
 
-This module sets the following variables:
-
-::
-
-  BLAS_FOUND - set to true if a library implementing the BLAS interface
-    is found
-  BLAS_LINKER_FLAGS - uncached list of required linker flags (excluding -l
-    and -L).
-  BLAS_LIBRARIES - uncached list of libraries (using full path name) to
-    link against to use BLAS (may be empty if compiler implicitly links
-    BLAS)
-  BLAS95_LIBRARIES - uncached list of libraries (using full path name)
-    to link against to use BLAS95 interface
-  BLAS95_FOUND - set to true if a library implementing the BLAS f95 interface
-    is found
-
-The following variables can be used to control this module:
-
-::
-
-  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
-  BLA_PREFER_PKGCONFIG  if set pkg-config will be used to search for a BLAS
-     library first and if one is found that is preferred
-
-List of vendors (BLA_VENDOR) valid in this module:
-
-* Goto
-* OpenBLAS
-* FLAME
-* ATLAS PhiPACK
-* CXML
-* DXML
-* SunPerf
-* SCSL
-* SGIMATH
-* IBMESSL
-* 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 (older versions of mkl 32 and 64 bit)
-* ACML
-* ACML_MP
-* ACML_GPU
-* 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:
+
+  * Goto
+  * OpenBLAS
+  * FLAME
+  * ATLAS PhiPACK
+  * CXML
+  * DXML
+  * SunPerf
+  * SCSL
+  * SGIMATH
+  * IBMESSL
+  * 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)
+  * ACML
+  * ACML_MP
+  * ACML_GPU
+  * Apple
+  * NAS
+  * Generic
+
+``BLA_F95``
+  if ``ON`` tries to find the BLAS95 interfaces
+
+``BLA_PREFER_PKGCONFIG``
+  if set pkg-config will be used to search for a BLAS library first
+  and if one is found that is preferred
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+This module defines the following variables:
+
+``BLAS_FOUND``
+  library implementing the BLAS interface is found
+``BLAS_LINKER_FLAGS``
+  uncached list of required linker flags (excluding -l and -L).
+``BLAS_LIBRARIES``
+  uncached list of libraries (using full path name) to link against
+  to use BLAS (may be empty if compiler implicitly links BLAS)
+``BLAS95_LIBRARIES``
+  uncached list of libraries (using full path name) to link against
+  to use BLAS95 interface
+``BLAS95_FOUND``
+  library implementing the BLAS95 interface is found
 
 .. note::
 
-  C/CXX should be enabled to use Intel mkl
+  C or CXX must be enabled to use Intel MKL
 
+  For example, to use Intel MKL libraries and/or Intel compiler:
+
+  .. code-block:: cmake
+
+    set(BLA_VENDOR Intel10_64lp)
+    find_package(BLAS)
 #]=======================================================================]
 
 include(${CMAKE_CURRENT_LIST_DIR}/CheckFunctionExists.cmake)