Bladeren bron

doc/chapters: reference STARPU_HOME instead of explaining it every time

Nathalie Furmento 12 jaren geleden
bovenliggende
commit
2c71f9694d

+ 2 - 3
doc/chapters/advanced-examples.texi

@@ -326,9 +326,8 @@ few different sets of data input/output sizes. StarPU will then keep record of
 the average time of previous executions on the various processing units, and use
 it as an estimation. History is done per task size, by using a hash of the input
 and ouput sizes as an index.
-It will also save it in @code{$HOME/.starpu/sampling/codelets}
-for further executions (@code{$USERPROFILE/.starpu/sampling/codelets} in windows
-environments), and can be observed by using the
+It will also save it in @code{$STARPU_HOME/.starpu/sampling/codelets}
+for further executions, and can be observed by using the
 @code{starpu_perfmodel_display} command, or drawn by using
 the @code{starpu_perfmodel_plot} (@pxref{Performance model calibration}).  The
 models are indexed by machine name. To

+ 3 - 4
doc/chapters/basic-api.texi

@@ -2223,7 +2223,7 @@ regression.
 @end deftp
 
 @deftypefun int starpu_perfmodel_load_symbol ({const char} *@var{symbol}, {struct starpu_perfmodel} *@var{model})
-loads a given performance model. The @var{model} structure has to be completely zero, and will be filled with the information saved in @code{$HOME/.starpu} (@code{$USERPROFILE/.starpu} in windows environments).
+loads a given performance model. The @var{model} structure has to be completely zero, and will be filled with the information saved in @code{$STARPU_HOME/.starpu}.
 @end deftypefun
 
 @deftypefun void starpu_perfmodel_debugfilepath ({struct starpu_perfmodel} *@var{model}, {enum starpu_perf_archtype} @var{arch}, char *@var{path}, size_t @var{maxlen}, unsigned nimpl)
@@ -2657,8 +2657,7 @@ to the empty string.
 Compile the OpenCL kernel stored in the file @code{source_file_name}
 with the given options @code{build_options} and stores the result in
 the directory @code{$STARPU_HOME/.starpu/opencl} with the same
-filename as @code{source_file_name} (@code{$USERPROFILE/.starpu/opencl} in
-windows environments). The compilation is done for every
+filename as @code{source_file_name}. The compilation is done for every
 OpenCL device, and the filename is suffixed with the vendor id and the
 device id of the OpenCL device.
 @end deftypefun
@@ -2667,7 +2666,7 @@ device id of the OpenCL device.
 Compile the OpenCL kernel in the string @code{opencl_program_source}
 with the given options @code{build_options} and stores the result in
 the directory @code{$STARPU_HOME/.starpu/opencl}
-(@code{$USERPROFILE/.starpu/opencl} in windows environments) with the filename
+with the filename
 @code{file_name}. The compilation is done for every
 OpenCL device, and the filename is suffixed with the vendor id and the
 device id of the OpenCL device.

+ 1 - 0
doc/chapters/configuration.texi

@@ -542,6 +542,7 @@ to 0. It is enabled by default or for any other values of the variable
 @subsection Miscellaneous and debug
 
 @defvr {Environment variable} STARPU_HOME
+@anchor{STARPU_HOME}
 This specifies the main directory in which StarPU stores its
 configuration files. The default is @code{$HOME} on Unix environments,
 and @code{$USERPROFILE} on Windows environments.

+ 2 - 2
doc/chapters/perf-optimization.texi

@@ -2,7 +2,7 @@
 
 @c This file is part of the StarPU Handbook.
 @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, 2013  Centre National de la Recherche Scientifique
 @c Copyright (C) 2011 Institut National de Recherche en Informatique et Automatique
 @c See the file starpu.texi for copying conditions.
 
@@ -248,7 +248,7 @@ to configure a performance model for the codelets of the application (see
 @ref{Performance model example} for instance). History-based performance models
 use on-line calibration.  StarPU will automatically calibrate codelets
 which have never been calibrated yet, and save the result in
-@code{~/.starpu/sampling/codelets} (@code{$USERPROFILE/.starpu/sampling/codelets} in windows environments)
+@code{$STARPU_HOME/.starpu/sampling/codelets}.
 The models are indexed by machine name. To share the models between machines (e.g. for a homogeneous cluster), use @code{export STARPU_HOSTNAME=some_global_name}. To force continuing calibration, use
 @code{export STARPU_CALIBRATE=1} . This may be necessary if your application
 has not-so-stable performance. StarPU will force calibration (and thus ignore

+ 1 - 2
doc/chapters/using.texi

@@ -82,8 +82,7 @@ AFTER: First element is 3.140000
 
 When StarPU is used for the first time, the directory
 @code{$STARPU_HOME/.starpu/} is created, performance models will be stored in
-that directory (@code{STARPU_HOME} defaults to @code{$HOME}, or @code{$USERPROFILE
-} in windows environments).
+that directory (@pxref{STARPU_HOME}).
 
 Please note that buses are benchmarked when StarPU is launched for the
 first time. This may take a few minutes, or less if @code{hwloc} is