Selaa lähdekoodia

doc: update w.r.t renaming of memory_status

Nathalie Furmento 13 vuotta sitten
vanhempi
commit
1f5ca8b7a7
2 muutettua tiedostoa jossa 9 lisäystä ja 11 poistoa
  1. 4 5
      doc/chapters/configuration.texi
  2. 5 6
      doc/chapters/perf-feedback.texi

+ 4 - 5
doc/chapters/configuration.texi

@@ -279,9 +279,8 @@ MKL website} provides a script to determine the linking flags.
 Disable the build of examples.
 @end defvr
 
-@defvr {Configure option} --enable-memory-status
-Enable the display of memory status at the end of the execution
-(@pxref{Memory feedback}).
+@defvr {Configure option} --enable-memory-stats
+Enable memory statistics (@pxref{Memory feedback}).
 @end defvr
 
 @node Execution configuration through environment variables
@@ -542,8 +541,8 @@ When set to 1, this variable indicates that StarPU should automatically
 generate a Paje trace when @code{starpu_shutdown()} is called.
 @end defvr
 
-@defvr {Environment variable} STARPU_MEMORY_STATUS
-Enable the display of memory status at the end of the execution
+@defvr {Environment variable} STARPU_MEMORY_STATS
+Display memory statistics on data which have not been unregistered at the end of the execution
 (@pxref{Memory feedback}).
 @end defvr
 

+ 5 - 6
doc/chapters/perf-feedback.texi

@@ -439,12 +439,11 @@ correct), and relaxed solving (which provides an approximate solution).
 @node Memory feedback
 @section Memory feedback
 
-It is possible to display memory usage at the end of the
-execution of your application. It allows to check all data allocated
-by StarPU have been cleared. To do so, you need to pass the option
-@code{--enable-memory-status} when running configure, and to set the
-environment variable @code{STARPU_MEMORY_STATUS} when running the
-application.
+It is possible to enable memory statistics. To do so, you need to pass the option
+@code{--enable-memory-stats} when running configure.
+
+Moreover, when setting the environment variable @code{STARPU_MEMORY_STATUS}, statistics will be displayed at the end
+of the execution on data handles which have not been cleared out.
 
 For example, if you do not unregister data at the end of the complex
 example, you will get something similar to: