X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d0b955213eaa7c1cd90108f336bb32e62c8039cb..1ea2b84113444364446ce170cb57f8f9bda67be2:/examples/msg/tracing/link_srcdst_user_variables.c

diff --git a/examples/msg/tracing/link_srcdst_user_variables.c b/examples/msg/tracing/link_srcdst_user_variables.c
index 5dc745c43f..aa1caf6d3c 100644
--- a/examples/msg/tracing/link_srcdst_user_variables.c
+++ b/examples/msg/tracing/link_srcdst_user_variables.c
@@ -1,17 +1,32 @@
-/* Copyright (c) 2012. The SimGrid Team.
+/* Copyright (c) 2012-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include <msg/msg.h>
+#include <simgrid/msg.h>
+
+/** @addtogroup MSG_examples
+ *
+ * - <b>tracing/link_srcdst_user_variables.c</b>: This program demonstrates how to
+ * trace user variables associated to the links of the platform file. Instead of
+ * providing the name of the link to update one of its variable, this example shows
+ * how to provide two hosts as parameter (source and destination, use their names as
+ * defined in the platform file). The tracing mechanism will get the route between
+ * these two hosts, if there is one defined in the platform file, and update the variable
+ * of all the links of that route to the value provided.
+ * You might want to run this program with the following parameters:
+ * --cfg=tracing:yes
+ * --cfg=tracing/platform:yes
+ * (See \ref tracing_tracing_options for details)
+ */
 
 int master(int argc, char *argv[]);
 
 //dump function to create and execute a task
 static void create_and_execute_task (void)
 {
-  m_task_t task = MSG_task_create("task", 1000000, 0, NULL);
+  msg_task_t task = MSG_task_create("task", 1000000, 0, NULL);
   MSG_task_execute (task);
   MSG_task_destroy (task);
 }
@@ -60,7 +75,7 @@ int master(int argc, char *argv[])
 /** Main function */
 int main(int argc, char *argv[])
 {
-  MSG_global_init(&argc, argv);
+  MSG_init(&argc, argv);
   if (argc < 3) {
     printf("Usage: %s platform_file deployment_file\n", argv[0]);
     exit(1);
@@ -80,6 +95,5 @@ int main(int argc, char *argv[])
   MSG_launch_application(deployment_file);
 
   MSG_main();
-  MSG_clean();
   return 0;
 }