From 7622b935dd8a79a4d564bd87bdee36195633b758 Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Mon, 2 Jul 2012 16:39:55 +0200 Subject: [PATCH] Tiny corrections in doc. --- doc/user_guide/doxygen/bindings.doc | 8 ++++---- doc/user_guide/doxygen/tracing.doc | 16 ++++++++-------- doc/user_guide/doxygen/use.doc | 2 +- src/simix/smx_user.c | 5 +++-- 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/doc/user_guide/doxygen/bindings.doc b/doc/user_guide/doxygen/bindings.doc index a5e5257d3f..83022e413a 100644 --- a/doc/user_guide/doxygen/bindings.doc +++ b/doc/user_guide/doxygen/bindings.doc @@ -169,7 +169,7 @@ the full example is distributed in the file examples/lua/master_slave_bypass.lua \subsubsection MSG_ext_ms_master_lua Master code - as described ine the C native master/Slave exmaple , this function has to be assigned to a m_process_t that will behave as the master. + as described in the C native master/Slave example, this function has to be assigned to a msg_process_t that will behave as the master. Lua style arguments (...) in for the master are interpreted as: - the number of tasks to distribute @@ -184,7 +184,7 @@ the full example is distributed in the file examples/lua/master_slave_bypass.lua \subsubsection MSG_ext_ms_slave_lua Slave code - This function has to be assigned to a #m_process_t that has to behave as a slave. + This function has to be assigned to a #msg_process_t that has to behave as a slave. This function keeps waiting for tasks and executes them as it receives them. \until end_of_slave @@ -219,7 +219,7 @@ the full example is distributed in the file examples/lua/master_slave_bypass.lua \subsubsection MSG_ext_ms_bp_master_lua Master code - as described ine the C native master/Slave exmaple , this function has to be assigned to a m_process_t that will behave as the master. + as described in the C native master/Slave example, this function has to be assigned to a msg_process_t that will behave as the master. Lua style arguments (...) in for the master are interpreted as: - the number of tasks to distribute @@ -234,7 +234,7 @@ the full example is distributed in the file examples/lua/master_slave_bypass.lua \subsubsection MSG_ext_ms_bp_slave_lua Slave code - This function has to be assigned to a #m_process_t that has to behave as a slave. + This function has to be assigned to a #msg_process_t that has to behave as a slave. This function keeps waiting for tasks and executes them as it receives them. \until end_of_slave diff --git a/doc/user_guide/doxygen/tracing.doc b/doc/user_guide/doxygen/tracing.doc index ad936edf44..7f0c4d33e7 100644 --- a/doc/user_guide/doxygen/tracing.doc +++ b/doc/user_guide/doxygen/tracing.doc @@ -48,8 +48,8 @@ $ make \section instr_category_functions Tracing categories functions \li \c TRACE_category(const char *category) \li \c TRACE_category_with_color(const char *category, const char *color) -\li \c MSG_task_set_category(m_task_t task, const char *category) -\li \c MSG_task_get_category(m_task_t task) +\li \c MSG_task_set_category(msg_task_t task, const char *category) +\li \c MSG_task_get_category(msg_task_t task) \li \c SD_task_set_category(SD_task_t task, const char *category) \li \c SD_task_get_category(SD_task_t task) @@ -283,19 +283,19 @@ int main (int argc, char **argv) TRACE_category_with_color ("computation", "0.3 1 0.4"); TRACE_category ("finalize"); - m_task_t req1 = MSG_task_create("1st_request_task", 10, 10, NULL); - m_task_t req2 = MSG_task_create("2nd_request_task", 10, 10, NULL); - m_task_t req3 = MSG_task_create("3rd_request_task", 10, 10, NULL); - m_task_t req4 = MSG_task_create("4th_request_task", 10, 10, NULL); + msg_task_t req1 = MSG_task_create("1st_request_task", 10, 10, NULL); + msg_task_t req2 = MSG_task_create("2nd_request_task", 10, 10, NULL); + msg_task_t req3 = MSG_task_create("3rd_request_task", 10, 10, NULL); + msg_task_t req4 = MSG_task_create("4th_request_task", 10, 10, NULL); MSG_task_set_category (req1, "request"); MSG_task_set_category (req2, "request"); MSG_task_set_category (req3, "request"); MSG_task_set_category (req4, "request"); - m_task_t comp = MSG_task_create ("comp_task", 100, 100, NULL); + msg_task_t comp = MSG_task_create ("comp_task", 100, 100, NULL); MSG_task_set_category (comp, "computation"); - m_task_t finalize = MSG_task_create ("finalize", 0, 0, NULL); + msg_task_t finalize = MSG_task_create ("finalize", 0, 0, NULL); MSG_task_set_category (finalize, "finalize"); //(...) diff --git a/doc/user_guide/doxygen/use.doc b/doc/user_guide/doxygen/use.doc index a403dacc00..4d24922d65 100644 --- a/doc/user_guide/doxygen/use.doc +++ b/doc/user_guide/doxygen/use.doc @@ -158,7 +158,7 @@ and an external description of the deployment. \paragraph MSG_ext_ms_master Master code -This function has to be assigned to a m_process_t that will behave as +This function has to be assigned to a msg_process_t that will behave as the master. It should not be called directly but either given as a parameter to #MSG_process_create() or registered as a public function through #MSG_function_register() and then automatically assigned to a diff --git a/src/simix/smx_user.c b/src/simix/smx_user.c index 771268f0dd..31b9c52cc8 100644 --- a/src/simix/smx_user.c +++ b/src/simix/smx_user.c @@ -534,7 +534,7 @@ void* simcall_process_get_data(smx_process_t process) * \ingroup simix_process_management * \brief Set the user data of a #smx_process_t. * - * This functions checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible. + * This functions sets the user data associated to \a process. * \param process SIMIX process * \param data User data */ @@ -577,7 +577,8 @@ void simcall_process_set_kill_time(smx_process_t process, double kill_time) * \ingroup simix_process_management * \brief Return the location on which an agent is running. * - * This functions checks whether \a process is a valid pointer or not and return the m_host_t corresponding to the location on which \a process is running. + * This functions returns the smx_host_t corresponding to the location on which + * \a process is running. * \param process SIMIX process * \return SIMIX host */ -- 2.20.1