Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] add some comments, cosmetics
authorschnorr <Lucas.Schnorr@imag.fr>
Wed, 21 Mar 2012 08:37:53 +0000 (09:37 +0100)
committerschnorr <Lucas.Schnorr@imag.fr>
Wed, 21 Mar 2012 11:46:04 +0000 (12:46 +0100)
include/instr/instr.h

index 0b8e869..3daca52 100644 (file)
 #include "msg/msg.h"
 #include "simdag/simdag.h"
 
 #include "msg/msg.h"
 #include "simdag/simdag.h"
 
+/*
+ * Functions to manage tracing categories
+ */
 XBT_PUBLIC(void) TRACE_category(const char *category);
 XBT_PUBLIC(void) TRACE_category_with_color (const char *category, const char *color);
 XBT_PUBLIC(void) TRACE_msg_set_task_category(m_task_t task, const char *category);
 XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category);
 XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task, const char *category);
 
 XBT_PUBLIC(void) TRACE_category(const char *category);
 XBT_PUBLIC(void) TRACE_category_with_color (const char *category, const char *color);
 XBT_PUBLIC(void) TRACE_msg_set_task_category(m_task_t task, const char *category);
 XBT_PUBLIC(void) TRACE_smpi_set_category(const char *category);
 XBT_PUBLIC(void) TRACE_sd_set_task_category(SD_task_t task, const char *category);
 
+/*
+ * Functions to manage tracing marks (used for trace comparison experiments)
+ */
 XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
 XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
 
 XBT_PUBLIC(void) TRACE_declare_mark(const char *mark_type);
 XBT_PUBLIC(void) TRACE_mark(const char *mark_type, const char *mark_value);
 
+/*
+ * Functions used by graphicator (transform a SimGrid platform
+ * file in a graphviz dot file with the network topology)
+ */
 XBT_PUBLIC(const char *) TRACE_node_name (xbt_node_t node);
 XBT_PUBLIC(xbt_graph_t) TRACE_platform_graph (void);
 XBT_PUBLIC(void) TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
 XBT_PUBLIC(const char *) TRACE_node_name (xbt_node_t node);
 XBT_PUBLIC(xbt_graph_t) TRACE_platform_graph (void);
 XBT_PUBLIC(void) TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);