document MSG tracing examples

[simgrid.git] / examples / msg / tracing / procmig.c

diff --git a/examples/msg/tracing/procmig.c b/examples/msg/tracing/procmig.c
index d2f5647..3c2121a 100644 (file)
--- a/examples/msg/tracing/procmig.c
+++ b/examples/msg/tracing/procmig.c
@@ -1,8 +1,20 @@
-/* Copyright (c) 2009 The SimGrid team. All rights reserved.                */
+/* Copyright (c) 2010 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. */
 
+/** @addtogroup MSG_examples
+ * 
+ * - <b>tracing/procmig.c</b> This program shows a process migration. Tracing
+ * this program with the options below enables a gantt-chart visualization
+ * of where the process has been during its execution. Migrations are represented by
+ * arrows from the origin to the destination host.
+ * You might want to run this program with the following parameters:
+ * --cfg=tracing:1
+ * --cfg=tracing/msg/process:1
+ * (See \ref tracing_tracing_options for details)
+ */
+
 #include "msg/msg.h"            /* core library */
 #include "xbt/sysdep.h"         /* calloc */
 
@@ -24,7 +36,6 @@ static int emigrant(int argc, char *argv[])
     destination = (char*)MSG_task_get_data (task);
     MSG_task_destroy (task);
     if (!destination) break; //there is no destination, die
-    XBT_INFO("Migrating to %s", destination);
     MSG_process_migrate(MSG_process_self(), MSG_get_host_by_name(destination));
     MSG_process_sleep(2); // I am tired, have to sleep for 2 seconds
     free (destination);
@@ -68,8 +79,6 @@ static int master(int argc, char *argv[])
 /** Main function */
 int main(int argc, char *argv[])
 {
-  MSG_error_t res = MSG_OK;
-
   /* Argument checking */
   MSG_global_init(&argc, argv);
   if (argc < 3) {