Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
document MSG tracing examples
[simgrid.git] / examples / msg / tracing / procmig.c
index 3efb251..3c2121a 100644 (file)
@@ -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 */