Skip to content

Commit ed11415

Browse files
committed
docs: add the build variables for BLAS/LAPACK functionality
1 parent c526b10 commit ed11415

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

docs/build_system.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ Most of the variables are detected automatically in
6060
[Makefile.prebuild](https://github.com/xianyi/OpenBLAS/blob/develop/Makefile.prebuild),
6161
if they are not set in the environment.
6262

63+
The most commonly used variables are documented below. There are more options
64+
though - please read the linked Makefiles if you want to see all variables.
6365

6466
### CPU related
6567

@@ -101,10 +103,8 @@ if they are not set in the environment.
101103
to `32` on a 32-bit platform).
102104
- `INTERFACE64`: build with 64-bit (ILP64) integer representations to support
103105
large array index values (incompatible with the standard 32-bit integer (LP64) API).
104-
105-
Note that both shared and static libraries will be built with the Make-based
106-
build. The CMake build provides `BUILD_SHARED_LIBS`/`BUILD_STATIC_LIBS`
107-
variables to allow building only one of the two.
106+
- `NO_STATIC`: if set to `1`, don't build a static library (default is `0`)
107+
- `NO_SHARED`: if set to `1`, don't build a shared library (default is `0`)
108108

109109
#### Data type options
110110

@@ -165,3 +165,18 @@ ensures that there are a sufficient number of buffer sets available.
165165
*and* to the library name
166166
- `SYMBOLSUFFIX`: suffix that, if given, will be added to all symbol names
167167
*and* to the library name
168+
169+
#### BLAS and LAPACK options
170+
171+
By default, the Fortran and C interfaces to BLAS and LAPACK are built,
172+
including deprecated functions, while
173+
[ReLAPACK](https://github.com/HPAC/ReLAPACK) is not.
174+
175+
- `NO_CBLAS`: if set to `1`, don't build the CBLAS interface (default is `0`)
176+
- `ONLY_CBLAS`: if set to `1`, only build the CBLAS interface (default is `0`)
177+
- `NO_LAPACK`: if set to `1`, don't build LAPACK (default is `0`)
178+
- `NO_LAPACKE`: if set to `1`, don't build the LAPACKE interface (default is `0`)
179+
- `BUILD_LAPACK_DEPRECATED`: if set to `0`, don't build deprecated LAPACK
180+
functions (default is `1`)
181+
- `BUILD_RELAPACK`: if set to `1`, build Recursive LAPACK on top of LAPACK
182+
(default is `0`)

0 commit comments

Comments
 (0)