Browse Source

doc: Flatten and clarify "Advanced configuration".

* doc/chapters/configuration.texi (Advanced configuration): Use a table
  instead of subsections.  Clarify some of the descriptions.
Ludovic Courtès 13 years ago
parent
commit
1a10a4d617
1 changed files with 49 additions and 86 deletions
  1. 49 86
      doc/chapters/configuration.texi

+ 49 - 86
doc/chapters/configuration.texi

@@ -3,7 +3,7 @@
 @c This file is part of the StarPU Handbook.
 @c This file is part of the StarPU Handbook.
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
 @c Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
 @c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
 @c Copyright (C) 2010, 2011, 2012  Centre National de la Recherche Scientifique
-@c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
+@c Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 @c See the file starpu.texi for copying conditions.
 
 
 @menu
 @menu
@@ -159,122 +159,85 @@ device. It is then available as the @code{STARPU_MAXIMPLEMENTATIONS} macro.
 @node Advanced configuration
 @node Advanced configuration
 @subsection Advanced configuration
 @subsection Advanced configuration
 
 
-@menu
+@table @code
-* --enable-perf-debug::         
-* --enable-model-debug::        
-* --enable-stats::              
-* --enable-maxbuffers::         
-* --enable-allocation-cache::   
-* --enable-opengl-render::      
-* --enable-blas-lib::           
-* --disable-starpufft::         
-* --with-magma::                
-* --with-fxt::                  
-* --with-perf-model-dir::       
-* --with-mpicc::                
-* --with-goto-dir::             
-* --with-atlas-dir::            
-* --with-mkl-cflags::           
-* --with-mkl-ldflags::          
-* --disable-gcc-extensions::    
-* --disable-socl::    
-* --disable-starpu-top::
-@end menu
 
 
-@node --enable-perf-debug
+@item --enable-perf-debug
-@subsubsection @code{--enable-perf-debug}
 Enable performance debugging through gprof.
 Enable performance debugging through gprof.
 
 
-@node --enable-model-debug
+@item --enable-model-debug
-@subsubsection @code{--enable-model-debug}
 Enable performance model debugging.
 Enable performance model debugging.
 
 
-@node --enable-stats
+@item --enable-stats
-@subsubsection @code{--enable-stats}
+@c see ../../src/datawizard/datastats.c
-Enable statistics.
+Enable gathering of memory transfer statistics.
 
 
-@node --enable-maxbuffers
+@item --enable-maxbuffers
-@subsubsection @code{--enable-maxbuffers=<nbuffers>}
 Define the maximum number of buffers that tasks will be able to take
 Define the maximum number of buffers that tasks will be able to take
 as parameters, then available as the @code{STARPU_NMAXBUFS} macro.
 as parameters, then available as the @code{STARPU_NMAXBUFS} macro.
 
 
-@node --enable-allocation-cache
+@item --enable-allocation-cache
-@subsubsection @code{--enable-allocation-cache}
 Enable the use of a data allocation cache to avoid the cost of it with
 Enable the use of a data allocation cache to avoid the cost of it with
 CUDA. Still experimental.
 CUDA. Still experimental.
 
 
-@node --enable-opengl-render
+@item --enable-opengl-render
-@subsubsection @code{--enable-opengl-render}
 Enable the use of OpenGL for the rendering of some examples.
 Enable the use of OpenGL for the rendering of some examples.
 @c TODO: rather default to enabled when detected
 @c TODO: rather default to enabled when detected
 
 
-@node --enable-blas-lib
+@item --enable-blas-lib
-@subsubsection @code{--enable-blas-lib=<name>}
 Specify the blas library to be used by some of the examples. The
 Specify the blas library to be used by some of the examples. The
 library has to be 'atlas' or 'goto'.
 library has to be 'atlas' or 'goto'.
 
 
-@node --disable-starpufft
+@item --disable-starpufft
-@subsubsection @code{--disable-starpufft}
 Disable the build of libstarpufft, even if fftw or cuFFT is available.
 Disable the build of libstarpufft, even if fftw or cuFFT is available.
 
 
-@node --with-magma
+@item --with-magma=@var{prefix}
-@subsubsection @code{--with-magma=<path>}
+Search for MAGMA under @var{prefix}.  @var{prefix} should notably
-Specify where magma is installed. This directory should notably contain
+contain @file{include/magmablas.h}.
-@code{include/magmablas.h}.
-
-@node --with-fxt
-@subsubsection @code{--with-fxt=<path>}
-Specify the location of FxT (for generating traces and rendering them
-using ViTE). This directory should notably contain
-@code{include/fxt/fxt.h}.
-@c TODO add ref to other section
-
-@node --with-perf-model-dir
-@subsubsection @code{--with-perf-model-dir=<dir>}
-Specify where performance models should be stored (instead of defaulting to the
-current user's home).
-
-@node --with-mpicc
-@subsubsection @code{--with-mpicc=<path to mpicc>}
-Specify the location of the @code{mpicc} compiler to be used for starpumpi.
 
 
-@node --with-goto-dir
+@item --with-fxt=@var{prefix}
-@subsubsection @code{--with-goto-dir=<dir>}
+Search for FxT under @var{prefix}.
-Specify the location of GotoBLAS.
+@url{http://savannah.nongnu.org/projects/fkt, FxT} is used to generate
+traces of scheduling events, which can then be rendered them using ViTE
+(@pxref{Off-line, off-line performance feedback}).  @var{prefix} should
+notably contain @code{include/fxt/fxt.h}.
 
 
-@node --with-atlas-dir
+@item --with-perf-model-dir=@var{dir}
-@subsubsection @code{--with-atlas-dir=<dir>}
+Store performance models under @var{dir}, instead of the current user's
-Specify the location of ATLAS. This directory should notably contain
+home.
-@code{include/cblas.h}.
 
 
-@node --with-mkl-cflags
+@item --with-mpicc=@var{path}
-@subsubsection @code{--with-mkl-cflags=<cflags>}
+Use the @command{mpicc} compiler at @var{path}, for starpumpi
-Specify the compilation flags for the MKL Library.
+(@pxref{StarPU MPI support}).
 
 
-@node --with-mkl-ldflags
+@item --with-goto-dir=@var{prefix}
-@subsubsection @code{--with-mkl-ldflags=<ldflags>}
+Search for GotoBLAS under @var{prefix}.
-Specify the linking flags for the MKL Library. Note that the
-@url{http://software.intel.com/en-us/articles/intel-mkl-link-line-advisor/}
-website provides a script to determine the linking flags.
 
 
-@node --disable-gcc-extensions
+@item --with-atlas-dir=@var{prefix}
-@subsubsection @code{--disable-gcc-extensions}
+Search for ATLAS under @var{prefix}, which should notably contain
+@file{include/cblas.h}.
 
 
-Disable the GCC plug-in. It is by default enabled if the GCC compiler
+@item --with-mkl-cflags=@var{cflags}
-provides a plug-in support.
+Use @var{cflags} to compile code that uses the MKL library.
 
 
-@node --disable-socl
+@item --with-mkl-ldflags=@var{ldflags}
-@subsubsection @code{--disable-socl}
+Use @var{ldflags} when linking code that uses the MKL library.  Note
+that the
+@url{http://software.intel.com/en-us/articles/intel-mkl-link-line-advisor/,
+MKL website} provides a script to determine the linking flags.
 
 
-Disable the SOCL extension. It is by default enabled if a valid OpenCL
+@item --disable-gcc-extensions
-installation is found.
+Disable the GCC plug-in (@pxref{C Extensions}).  By default, it is
+enabled when the GCC compiler provides a plug-in support.
 
 
-@node --disable-starpu-top
+@item --disable-socl
-@subsubsection @code{--disable-starpu-top}
+Disable the SOCL extension (@pxref{SOCL OpenCL Extensions}).  By
+default, it is enabled when an OpenCL implementation is found.
 
 
-Disable the StarPU-Top interface. It is by default enabled if the required
+@item --disable-starpu-top
-dependencies are found.
+Disable the StarPU-Top interface (@pxref{starpu-top}).  By default, it
+is enabled when the required dependencies are found.
 
 
+@end table
 @node Execution configuration through environment variables
 @node Execution configuration through environment variables
 @section Execution configuration through environment variables
 @section Execution configuration through environment variables