improve documentation on the way

[simgrid.git] / src / msg / msg_config.c

diff --git a/src/msg/msg_config.c b/src/msg/msg_config.c
index 999e6cf..71758ee 100644 (file)
--- a/src/msg/msg_config.c
+++ b/src/msg/msg_config.c
@@ -4,22 +4,14 @@
 /* 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/private.h"
+#include "msg_private.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
-#include "simix/simix.h"
+#include "simgrid/simix.h"
 
 /** \brief set a configuration variable
  *
- * Currently existing configuation variable:
- *   - workstation/model (string): Model of workstation to use.
- *     Possible values (defaults to "KCCFLN05"):
- *     - "CLM03": realistic TCP behavior + basic CPU model (see [CML03 at CCGrid03]) + support for parallel tasks
- *     - "KCCFLN05": realistic TCP behavior + basic CPU model (see [CML03 at CCGrid03]) + failure handling + interference between communications and computations if precised in the platform file.
- *     - "KCCFLN05": realistic TCP behavior + basic CPU model (see [CML03 at CCGrid03]) + failure handling + interference between communications and computations if precised in the platform file. Use maxmin for the network.
- *     - "KCCFLN05_proportional": realistic TCP behavior + basic CPU model (see [CML03 at CCGrid03]) + failure handling + interference between communications and computations if precised in the platform file. Uses the proportional approahc as described in the Corine Touati's PhD Thesis.
- *     - "KCCFLN05_Vegas": realistic TCP behavior + basic CPU model (see [CML03 at CCGrid03]) + failure handling + interference between communications and computations if precised in the platform file. Uses the fairness adapted to the TCP Vegas flow control.
- *     - "KCCFLN05_Reno": realistic TCP behavior + basic CPU model (see [CML03 at CCGrid03]) + failure handling + interference between communications and computations if precised in the platform file. Uses the fairness adapted to the TCP Reno flow control.
+ * Do --help on any simgrid binary to see the list of currently existing configuration variables
  *
  * Example:
  * MSG_config("workstation/model","KCCFLN05");