From e72a344e94c5ae253f69b60f41d92ca89a5d1d1c Mon Sep 17 00:00:00 2001 From: "Field G. Van Zee" Date: Wed, 1 Aug 2018 13:00:38 -0500 Subject: [PATCH 1/2] Added table of 'make' targets to BuildSystem.md. Details: - Added a new section to BuildSystem.md that describes the most useful make targets defined in the top-level Makefile. --- docs/BuildSystem.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/BuildSystem.md b/docs/BuildSystem.md index bd58849b5..3a1f6fd31 100644 --- a/docs/BuildSystem.md +++ b/docs/BuildSystem.md @@ -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//`. | +| `cleanlib` | Remove the libraries in `lib//`. | +| `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 From ebe998d06cc56a9a9d66990b6ebf683d6fd0efdf Mon Sep 17 00:00:00 2001 From: "Field G. Van Zee" Date: Wed, 1 Aug 2018 13:24:00 -0500 Subject: [PATCH 2/2] Fixed typos in BuildSystem.md from previuos commit. --- docs/BuildSystem.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/BuildSystem.md b/docs/BuildSystem.md index 3a1f6fd31..69be8c076 100644 --- a/docs/BuildSystem.md +++ b/docs/BuildSystem.md @@ -385,10 +385,10 @@ The BLIS `Makefile` implements many `make` targets. The table below lists most o | `make` target | Description | |:----------------|:---------------------------------------------------| | `all` | Execute `libs` target. | -| `libs` | Compile BLIS as a static and/or shared library (depending on `configure` options. | +| `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. | +| `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. |