Browse Source

doc/: add missing doc

Nathalie Furmento 12 years ago
parent
commit
07c734a366
3 changed files with 33 additions and 5 deletions
  1. 4 2
      doc/chapters/basic-api.texi
  2. 27 1
      doc/chapters/configuration.texi
  3. 2 2
      doc/chapters/perf-feedback.texi

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

@@ -2568,7 +2568,8 @@ use (e.g. different programs on the different OpenCL devices, for
 relocation purpose for instance).
 
 @deftp {Data Type} {struct starpu_opencl_program}
-Stores the OpenCL programs as compiled for the different OpenCL devices.
+Stores the OpenCL programs as compiled for the different OpenCL
+devices. The different fields are:
 @table @asis
 @item @code{cl_program programs[STARPU_MAXOPENCLDEVS]}
 Stores each program for each OpenCL device.
@@ -2589,10 +2590,11 @@ This function unloads an OpenCL compiled code.
 @end deftypefun
 
 @deftypefun void starpu_opencl_load_program_source ({const char *}@var{source_file_name}, char *@var{located_file_name}, char *@var{located_dir_name}, char *@var{opencl_program_source})
+@anchor{starpu_opencl_load_program_source}
 Store the contents of the file @var{source_file_name} in the buffer
 @var{opencl_program_source}. The file @var{source_file_name} can be
 located in the current directory, or in the directory specified by the
-environment variable @code{STARPU_OPENCL_PROGRAM_DIR}, or in the
+environment variable @code{STARPU_OPENCL_PROGRAM_DIR} (@pxref{STARPU_OPENCL_PROGRAM_DIR}), or in the
 directory @code{share/starpu/opencl} of the installation directory of
 StarPU, or in the source directory of StarPU.
 When the file is found, @code{located_file_name} is the full name of

+ 27 - 1
doc/chapters/configuration.texi

@@ -293,6 +293,10 @@ more CPU workers than there are physical CPUs, and that some CPUs are used to co
 the accelerators.
 @end defvr
 
+@defvr {Environment variable} STARPU_NCPUS
+This variable is deprecated. You should use @code{STARPU_NCPU}.
+@end defvr
+
 @defvr {Environment variable} STARPU_NCUDA
 Specify the number of CUDA devices that StarPU can use. If
 @code{STARPU_NCUDA} is lower than the number of physical devices, it is
@@ -367,7 +371,7 @@ concurrently. It will create combined workers which size goes from 1 to the
 total number of CPU workers in the system.
 @end defvr
 
-@defvr {Environment variable} SYNTHESIZE_ARITY_COMBINED_WORKER
+@defvr {Environment variable} STARPU_SYNTHESIZE_ARITY_COMBINED_WORKER
 Let the user decide how many elements are allowed between combined workers
 created from hwloc information. For instance, in the case of sockets with 6
 cores without shared L2 caches, if @code{SYNTHESIZE_ARITY_COMBINED_WORKER} is
@@ -452,6 +456,18 @@ data transfer time (obtained thanks to performance models). The beta factor is
 the coefficient to be applied to it before adding it to the computation part.
 @end defvr
 
+@defvr {Environment variable} STARPU_SCHED_GAMMA
+Define the execution time penalty of a joule (@pxref{Power-based scheduling}).
+@end defvr
+
+@defvr {Environment variable} STARPU_IDLE_POWER
+Define the idle power of the machine (@pxref{Power-based scheduling}).
+@end defvr
+
+@defvr {Environment variable} STARPU_PROFILING
+Enable on-line performance monitoring (@pxref{Enabling on-line performance monitoring}).
+@end defvr
+
 @node Extensions
 @subsection Extensions
 
@@ -479,6 +495,16 @@ to 0. It is enabled by default or for any other values of the variable
 @node Misc
 @subsection Miscellaneous and debug
 
+@defvr {Environment variable} STARPU_OPENCL_PROGRAM_DIR
+@anchor{STARPU_OPENCL_PROGRAM_DIR}
+This specifies the directory where the OpenCL codelet source files are
+located. The function @ref{starpu_opencl_load_program_source} looks
+for the codelet in the current directory, in the directory specified
+by the environment variable @code{STARPU_OPENCL_PROGRAM_DIR}, in the
+directory @code{share/starpu/opencl} of the installation directory of
+StarPU, and finally in the source directory of StarPU.
+@end defvr
+
 @defvr {Environment variable} STARPU_SILENT
 This variable allows to disable verbose mode at runtime when StarPU
 has been configured with the option @code{--enable-verbose}. It also

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

@@ -17,7 +17,7 @@
 @section On-line performance feedback
 
 @menu
-* Enabling monitoring::         Enabling on-line performance monitoring
+* Enabling on-line performance monitoring::
 * Task feedback::               Per-task feedback
 * Codelet feedback::            Per-codelet feedback
 * Worker feedback::             Per-worker feedback
@@ -25,7 +25,7 @@
 * StarPU-Top::                  StarPU-Top interface
 @end menu
 
-@node Enabling monitoring
+@node Enabling on-line performance monitoring
 @subsection Enabling on-line performance monitoring
 
 In order to enable online performance monitoring, the application can call