From 67be7d4e13af5aa966d500ed4a71844b1669cc81 Mon Sep 17 00:00:00 2001 From: Klaus Iglberger Date: Fri, 24 Aug 2012 13:43:39 +0200 Subject: [PATCH] Improve the description of the compilation step in the INSTALL file and the Blaze tutorial --- INSTALL | 14 +++++++++----- blaze/Blaze.h | 15 +++++++++------ 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/INSTALL b/INSTALL index 6510b4fb..05649ac9 100644 --- a/INSTALL +++ b/INSTALL @@ -35,7 +35,7 @@ vi ./Configfile In the 'Configfile', the kind of installation (debug or release), the library types (static and/or dynamic), the compiler including compiler flags, and several include paths have to be specified. Afterwards, the 'configure' script can be run, which uses the 'Configfile' to update and create -several files: +several files (including header files): ./configure @@ -53,7 +53,10 @@ Windows Users ------------- Unfortunately, for Windows users there is no 'configure' script available (yet). Therefore Windows -users have to manually configure the Blaze library in the './blaze/config/' subdirectory. +users have to manually configure the Blaze library. Most configuration headers are located in the +'./blaze/config/' subdirectory. The one exception is the 'BLAS.h' header in the './blaze/system/' +subdirectory that contains the configuration of the BLAS functionality. Note that in case the +'BLAZE_BLAS_MODE' symbol is set to 1, the correct BLAS header file has to be specified! Step 2: Installation @@ -99,9 +102,10 @@ Step 3 (Optional): Compilation Linux/MacOSX Users ------------------ -If certain extended functionality, such as for instance blaze::ThreadPool or the blaze::logging -functionality, is required, it is necessary to create the Blaze library files. For that purpose, -the 'configure' script has created a 'Makefile' that can be used for the compilation process: +Next to the math library, Blaze also contains a small number of additional (sub-)libraries. If +these libraries, such as blaze::ThreadPool or the blaze::logging functionality, are required +it is necessary to create the Blaze library files. For that purpose, the 'configure' script has +created a 'Makefile' that can be used for the compilation process: make diff --git a/blaze/Blaze.h b/blaze/Blaze.h index 511d6adc..c2249c43 100644 --- a/blaze/Blaze.h +++ b/blaze/Blaze.h @@ -161,8 +161,11 @@ namespace blaze {} // \n \subsection step_1_configuration_windows Windows User // // Unfortunately, for Windows users there is no \c configure script available (yet). Therefore -// Windows user have to manually configure the \b Blaze library in the ./blaze/config/ -// subdirectory. +// Windows user have to manually configure the \b Blaze library. Most configuration headers are +// located in the ./blaze/config/ subdirectory. The one exception is the \c BLAS.h +// header in the ./blaze/system/ subdirectory that contains the configuration of the +// BLAS functionality. Note that in case the \c BLAZE_BLAS_MODE symbol is set to 1, the correct +// BLAS header file has to be specified! // // // \n \section step_2_installation Step 2: Installation @@ -212,10 +215,10 @@ namespace blaze {} // // \subsection step_3_configuration_unix Linux/MacOSX User // -// If certain extended functionality, such as for instance blaze::ThreadPool or the blaze::logging -// functionality, is required, it is necessary to create the \b Blaze library files. For that -// purpose, the \c configure script has created a \c Makefile that can be used for the compilation -// process: +// Next to the math library, \b Blaze also contains a small number of additional (sub-)libraries. +// If these libraries, such as blaze::ThreadPool or the blaze::logging functionality, are required +// it is necessary to create the \b Blaze library files. For that purpose, the \c configure script +// has created a \c Makefile that can be used for the compilation process: \code make