From: Martin Quinson <martin.quinson@loria.fr>
Date: Wed, 13 Jan 2016 14:31:51 +0000 (+0100)
Subject: document the update mechanisms
X-Git-Tag: v3_13~1258
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/8dc65d690dc5d82bae067b9748e5ee463d17220f

document the update mechanisms
---

diff --git a/src/surf/surf_private.h b/src/surf/surf_private.h
index 954a1931d9..aa79814f73 100644
--- a/src/surf/surf_private.h
+++ b/src/surf/surf_private.h
@@ -30,8 +30,11 @@ extern XBT_PRIVATE const char *surf_action_state_names[6];
  * @brief Possible update mechanisms
  */
 typedef enum {
-  UM_FULL,      /**< [TODO] */
-  UM_LAZY,      /**< [TODO] */
+  UM_FULL,      /**< Full update mechanism: the remaining time of every action is recomputed at each step */
+  UM_LAZY,      /**< Lazy update mechanism: only the modified actions get recomputed.
+                     It may be slower than full if your system is tightly coupled to the point where every action
+                     gets recomputed anyway. In that case, you'd better not try to be cleaver with lazy and go for
+                     a simple full update.  */
   UM_UNDEFINED  /**< Mechanism not defined */
 } e_UM_t;