can be interesting to get the value of the alpha parameter for parallel

[simgrid.git] / src / msg / msg_task.c

diff --git a/src/msg/msg_task.c b/src/msg/msg_task.c
index 117a72e..013c4f1 100644 (file)
--- a/src/msg/msg_task.c
+++ b/src/msg/msg_task.c
@@ -119,9 +119,9 @@ MSG_parallel_task_create(const char *name, int host_nb,
 
 /*************** Begin GPU ***************/
 /** \ingroup m_task_management
- * \brief Creates a new #m_gpu_task_t.
+ * \brief Creates a new #msg_gpu_task_t.
 
- * A constructor for #m_gpu_task_t taking four arguments and returning
+ * A constructor for #msg_gpu_task_t taking four arguments and returning
    a pointer to the new created GPU task.
 
  * \param name a name for the object. It is for user-level information
@@ -136,7 +136,7 @@ MSG_parallel_task_create(const char *name, int host_nb,
  * \param collect_latency time in seconds to transfer result from the GPU
    back to the CPU (host) when done
 
- * \see m_gpu_task_t
+ * \see msg_gpu_task_t
  * \return The new corresponding object.
  */
 msg_gpu_task_t MSG_gpu_task_create(const char *name, double compute_duration,
@@ -298,7 +298,7 @@ msg_error_t MSG_task_destroy(msg_task_t task)
  */
 msg_error_t MSG_task_cancel(msg_task_t task)
 {
-  xbt_assert((task != NULL), "Invalid parameter");
+  xbt_assert((task != NULL), "Cannot cancel a NULL task");
 
   if (task->simdata->compute) {
     simcall_host_execution_cancel(task->simdata->compute);
@@ -312,7 +312,9 @@ msg_error_t MSG_task_cancel(msg_task_t task)
 
 /** \ingroup m_task_management
  * \brief Returns the computation amount needed to process a task #msg_task_t.
- *        Once a task has been processed, this amount is thus set to 0...
+ *
+ * Once a task has been processed, this amount is set to 0. If you want, you
+ * can reset this value with #MSG_task_set_compute_duration before restarting the task.
  */
 double MSG_task_get_compute_duration(msg_task_t task)
 {
@@ -325,6 +327,11 @@ double MSG_task_get_compute_duration(msg_task_t task)
 
 /** \ingroup m_task_management
  * \brief set the computation amount needed to process a task #msg_task_t.
+ *
+ * \warning If the computation is ongoing (already started and not finished),
+ * it is not modified by this call. And the termination of the ongoing task with
+ * set the computation_amount to zero, overriding any value set during the
+ * execution.
  */
 
 void MSG_task_set_compute_duration(msg_task_t task,
@@ -338,6 +345,9 @@ void MSG_task_set_compute_duration(msg_task_t task,
 /** \ingroup m_task_management
  * \brief Returns the remaining computation amount of a task #msg_task_t.
  *
+ * If the task is ongoing, this call retrieves the remaining amount of work.
+ * If it is not ongoing, it returns the total amount of work that will be
+ * executed when the task starts.
  */
 double MSG_task_get_remaining_computation(msg_task_t task)
 {