瀏覽代碼

doc: add STARPU_WATCHDOG_TIMEOUT and STARPU_WATCHDOG_CRASH in environment variable index

Nathalie Furmento 11 年之前
父節點
當前提交
8ff8463ad2
共有 2 個文件被更改,包括 20 次插入1 次删除
  1. 19 0
      doc/doxygen/chapters/environment_variables.doxy
  2. 1 1
      doc/doxygen/chapters/optimize_performance.doxy

+ 19 - 0
doc/doxygen/chapters/environment_variables.doxy

@@ -548,6 +548,25 @@ When set to 0, data statistics will not be displayed at the
 end of the execution of an application (\ref DataStatistics).
 </dd>
 
+<dt>STARPU_WATCHDOG_TIMEOUT</dt>
+<dd>
+\anchor STARPU_WATCHDOG_TIMEOUT
+\addindex __env__STARPU_WATCHDOG_TIMEOUT
+When set to a value other than 0, allows to make StarPU print an error
+message whenever StarPU does not terminate any task for 10ms. Should
+be used in combination with \ref STARPU_WATCHDOG_CRASH (see \ref
+DetectionStuckConditions).
+</dd>
+
+<dt>STARPU_WATCHDOG_CRASH</dt>
+<dd>
+\anchor STARPU_WATCHDOG_CRASH
+\addindex __env__STARPU_WATCHDOG_CRASH
+When set to a value other than 0, it triggers a crash when the watch
+dog is reached, thus allowing to catch the situation in gdb, etc
+(see \ref DetectionStuckConditions)
+</dd>
+
 </dl>
 
 \section ConfiguringTheHypervisor Configuring The Hypervisor

+ 1 - 1
doc/doxygen/chapters/optimize_performance.doxy

@@ -382,7 +382,7 @@ Statistics on the execution can then be obtained by using <c>export
 STARPU_BUS_STATS=1</c> and <c>export STARPU_WORKER_STATS=1</c> .
  More details on performance feedback are provided by the next chapter.
 
-\section Detection stuck conditions
+\section DetectionStuckConditions Detection Stuck Conditions
 
 It may happen that for some reason, StarPU does not make progress for a long
 period of time.  Reason are sometimes due to contention inside StarPU, but