Browse Source

doc: document destroy is set to 1 when calling starpu_task_create()

Nathalie Furmento 13 years ago
parent
commit
15e2e33d0b
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/chapters/basic-api.texi

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

@@ -1332,7 +1332,8 @@ after the execution of the callback if the task is detached, or during
 @code{starpu_task_wait} otherwise. If this flag is not set, dynamically
 allocated data structures will not be freed until @code{starpu_task_destroy} is
 called explicitly. Setting this flag for a statically allocated task structure
-will result in undefined behaviour.
+will result in undefined behaviour. The flag is set to 1 when the task
+is created by calling @code{starpu_task_create()}.
 
 @item @code{int regenerate} (optional)
 If this flag is set, the task will be re-submitted to StarPU once it has been