amd/blis
1
0
Fork 0
mirror of https://github.com/amd/blis.git synced 2026-04-19 23:28:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added table of 'make' targets to BuildSystem.md.

Browse Source 
Details:
- Added a new section to BuildSystem.md that describes the most useful
  make targets defined in the top-level Makefile.
This commit is contained in:
Field G. Van Zee
2018-08-01 13:00:38 -05:00
parent 4f60d0288e
commit e72a344e94
1 changed files with 30 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/BuildSystem.md
View File

@@ -11,6 +11,7 @@
* **[Cleaning out build products](BuildSystem.md#cleaning-out-build-products)**
* **[Linking against BLIS](BuildSystem.md#linking-against-blis)**
* **[Uninstalling](BuildSystem.md#uninstalling)**
* **[make targets](BuildSystem.md#make-targets)**
* **[Conclusion](BuildSystem.md#conclusion)**
## Introduction
@@ -376,6 +377,35 @@ Uninstalling directory 'blis' from /u/field/blis/include/.
This removes the libraries, symlinks, and header directory that was installed by `make install`. Before running `make uninstall`, however, make sure that BLIS is configured the with the same `LIBDIR` and `INCDIR` paths used during installation.
## `make` targets
The BLIS `Makefile` implements many `make` targets. The table below lists most of the interesting ones that typical users and developers may wish to use.
| `make` target | Description |
|:----------------|:---------------------------------------------------|
| `all` | Execute `libs` target. |
| `libs` | Compile BLIS as a static and/or shared library (depending on `configure` options. |
| `test` | Execute `testblis` and `testblas` targets. |
| `testblis` | Run the BLIS testsuite with default parameters (runs for 2-8 minutes). |
| `testblis-fast` | Run the BLIS testsuite with "fast" parameters (runs for a few seconds. |
| `testsuite` | Same as `testblis`. |
| `testblas` | Run the BLAS test drivers with default parameters (runs for a few seconds). |
| `check` | Execute `checkblis-fast` and `checkblas` targets. |
| `checkblis` | Execute `testblis` and characterize the results to `stdout`. |
| `checkblis-fast`| Execute `testblis-fast` and characterize the results to `stdout`. |
| `checkblas` | Execute `testblas` and characterize the results to `stdout`. |
| `showconfig` | Show a summary of currently selected `configure` options. |
| `clean` | Execute `cleanh` and `cleanlib`. |
| `cleanmk` | Remove `.fragment.mk` makefile fragments generated by `configure`. |
| `cleanh` | Remove the flattened header file(s) in `include/<config>/`. |
| `cleanlib` | Remove the libraries in `lib/<config>/`. |
| `cleantest` | Remove build products produced by `testblis`/`testblis-fast` and `testblas`. |
| `install` | Install libraries and header files to installation directories. |
| `uninstall` | Uninstall libraries and header files that reside within installation directories. |
| `uninstall-old` | Uninstall older libraries and header files that reside within installation directories. |
For more details on `configure` options, such as enabling/disabling static or shared library generation, or specifying installation directories for libraries and/or headers, please review the output of `./configure --help`.
## Conclusion