floraachy/OpenBLAS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc improvements squish

Browse Source 
* Fix more broken links
* Move FAQ last
* Fold all install-y content into `install.md`
* Fix header levels
* Fold `download.md` contents into `install.md`
* Fix cross-references
* Ordered navigation
* Add logo to docs
* Make doc pages more consistent
This commit is contained in:
Matthew Barber
2023-08-04 18:48:33 +01:00
parent 6c8c060c75
commit 9cfcee131e
24 changed files with 1213 additions and 825 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/build_system.md
View File

@@ -1,6 +1,7 @@
**This page is made by someone who is not the developer and should not be considered as an official documentation of the build system. For getting the full picture, it is best to read the Makefiles and understand them yourself.**
!!! warning
This page is made by someone who is not the developer and should not be considered as an official documentation of the build system. For getting the full picture, it is best to read the Makefiles and understand them yourself.
### Makefile dep graph
## Makefile dep graph
```
Makefile
@@ -41,12 +42,12 @@ Makefile
|~~~~~ relapack/
```
### Important Variables
## Important Variables
Most of the tunable variables are found in [Makefile.rule](https://github.com/xianyi/OpenBLAS/blob/develop/Makefile.rule), along with their detailed descriptions.<br/>
Most of the variables are detected automatically in [Makefile.prebuild](https://github.com/xianyi/OpenBLAS/blob/develop/Makefile.prebuild), if they are not set in the environment.
#### CPU related
### CPU related
```
ARCH - Target architecture (eg. x86_64)
TARGET - Target CPU architecture, in case of DYNAMIC_ARCH=1 means library will not be usable on less capable CPUs
@@ -55,7 +56,7 @@ DYNAMIC_ARCH - For building library for multiple TARGETs (does not lose any opti
DYNAMIC_LIST - optional user-provided subset of the DYNAMIC_CORE list in Makefile.system
```
#### Toolchain related
### Toolchain related
```
CC - TARGET C compiler used for compilation (can be cross-toolchains)
FC - TARGET Fortran compiler used for compilation (can be cross-toolchains, set NOFORTRAN=1 if used cross-toolchain has no fortran compiler)
@@ -65,7 +66,7 @@ HOSTCC - compiler of build machine, needed to create proper config f
HOST_CFLAGS - flags for build machine compiler
```
#### Library related
### Library related
```
BINARY - 32/64 bit library