From: scastelli Date: Wed, 4 Jun 2014 18:17:18 +0000 (+0200) Subject: Some minor documentation fixes X-Git-Tag: v3_12~1006 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/ed6092e7baf2eb4a875f5b8a667838ef1979862c Some minor documentation fixes --- diff --git a/src/surf/surf_interface.cpp b/src/surf/surf_interface.cpp index 6a64cb31a5..cc093ad3ce 100644 --- a/src/surf/surf_interface.cpp +++ b/src/surf/surf_interface.cpp @@ -25,29 +25,35 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_kernel, surf, /* This function is a pimple that we ought to fix. But it won't be easy. * - * The surf_solve() function does properly return the set of actions that changed. - * Instead, each model change a global data, and then the caller of surf_solve must - * pick into these sets of action_failed and action_done. + * The surf_solve() function does properly return the set of actions that + * changed. Instead, each model change a global data, and then the caller of + * surf_solve must pick into these sets of action_failed and action_done. * - * This was not clean but ok as long as we didn't had to restart the processes when the resource comes back up. - * We worked by putting sentinel actions on every resources we are interested in, - * so that surf informs us if/when the corresponding resource fails. + * This was not clean but ok as long as we didn't had to restart the processes + * when the resource comes back up. + * We worked by putting sentinel actions on every resources we are interested + * in, so that surf informs us if/when the corresponding resource fails. * - * But this does not work to get Simix informed of when a resource comes back up, and this is where this pimple comes. - * We have a set of resources that are currently down and for which simix needs to know when it comes back up. - * And the current function is called *at every simulation step* to sweep over that set, searching for a resource - * that was turned back up in the meanwhile. This is UGLY and slow. + * But this does not work to get Simix informed of when a resource comes back + * up, and this is where this pimple comes. We have a set of resources that are + * currently down and for which simix needs to know when it comes back up. + * And the current function is called *at every simulation step* to sweep over + * that set, searching for a resource that was turned back up in the meanwhile. + * This is UGLY and slow. * - * The proper solution would be to not rely on globals for the action_failed and action_done swags. - * They must be passed as parameter by the caller (the handling of these actions in simix may let you - * think that these two sets can be merged, but their handling in SimDag induce the contrary unless this - * simdag code can check by itself whether the action is done of failed -- seems very doable, but yet more - * cleanup to do). + * The proper solution would be to not rely on globals for the action_failed and + * action_done swags. They must be passed as parameter by the caller (the + * handling of these actions in simix may let you think that these two sets can + * be merged, but their handling in SimDag induce the contrary unless this + * simdag code can check by itself whether the action is done of failed -- seems + * very doable, but yet more cleanup to do). * - * Once surf_solve() is passed the set of actions that changed, you want to add a new set of resources back up - * as parameter to this function. You also want to add a boolean field "restart_watched" to each resource, and - * make sure that whenever a resource with this field enabled comes back up, it's added to that set so that Simix - * sees it and react accordingly. This would kill that need for surf to call simix. + * Once surf_solve() is passed the set of actions that changed, you want to add + * a new set of resources back up as parameter to this function. You also want + * to add a boolean field "restart_watched" to each resource, and make sure that + * whenever a resource with this field enabled comes back up, it's added to that + * set so that Simix sees it and react accordingly. This would kill that need + * for surf to call simix. * */ @@ -99,7 +105,8 @@ s_surf_model_description_t surf_plugin_description[] = { {NULL, NULL, NULL} /* this array must be NULL terminated */ }; -/* Don't forget to update the option description in smx_config when you change this */ +/* Don't forget to update the option description in smx_config when you change + this */ s_surf_model_description_t surf_network_model_description[] = { {"LV08", "Realistic network analytic model (slow-start modeled by multiplying latency by 10.4, bandwidth by .92; bottleneck sharing uses a payload of S=8775 for evaluating RTT). ", diff --git a/src/surf/surf_interface.hpp b/src/surf/surf_interface.hpp index 4270a6e599..eef00fbbd3 100644 --- a/src/surf/surf_interface.hpp +++ b/src/surf/surf_interface.hpp @@ -627,7 +627,6 @@ public: /** * @brief Get the state set in which the action is - * @details [TODO] * * @return The state set in which the action is */ @@ -650,10 +649,9 @@ private: /** * @brief Share the resources to the actions - * @details [TODO] * * @param now [TODO] - * @return in how much time the next action may terminatedescription] + * @return In how much time the next action may terminate */ double shareResources(double now);