Updating the documentation

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@820 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/examples/msg/Makefile.am b/examples/msg/Makefile.am
index 9deaf09..c78cc57 100644 (file)
--- a/examples/msg/Makefile.am
+++ b/examples/msg/Makefile.am
@@ -1,6 +1,6 @@
 INCLUDES= -I$(top_srcdir)/include
 AM_CFLAGS=-g
 INCLUDES= -I$(top_srcdir)/include
 AM_CFLAGS=-g

-EXTRA_DIST= msg_deployment.xml msg_platform.xml 
+EXTRA_DIST= msg_deployment.xml msg_platform.xml small_platform.xml small_deployment.xml

 
 check_PROGRAMS=msg_test
 
 
 check_PROGRAMS=msg_test
 

diff --git a/examples/msg/small_deployment.xml b/examples/msg/small_deployment.xml
new file mode 100644 (file)
index 0000000..9063eee
--- /dev/null
+++ b/examples/msg/small_deployment.xml
@@ -0,0 +1,19 @@
+<?xml version='1.0'?>
+<!DOCTYPE platform_description SYSTEM "surfxml.dtd">
+<platform_description>
+  <!-- The master process (with some arguments) -->
+  <process host="Tremblay" function="master">
+     <argument value="20"/>       <!-- Number of tasks -->
+     <argument value="50000"/>    <!-- Computation size of tasks -->
+     <argument value="10"/>       <!-- Communication size of tasks -->
+     <argument value="Jupiter"/>  <!-- First slave -->
+     <argument value="Fafard"/>   <!-- Second slave -->
+     <argument value="Ginette"/>  <!-- Third slave -->
+     <argument value="Bourassa"/> <!-- Last slave -->
+  </process>
+  <!-- The slave process (with no argument) -->
+  <process host="Jupiter" function="slave"/>
+  <process host="Fafard" function="slave"/>
+  <process host="Ginette" function="slave"/>
+  <process host="Bourassa" function="slave"/>
+</platform_description>

diff --git a/examples/msg/small_platform.xml b/examples/msg/small_platform.xml
index 2ba0ef5..826b6f2 100644 (file)
--- a/examples/msg/small_platform.xml
+++ b/examples/msg/small_platform.xml
@@ -1,6 +1,7 @@
 <?xml version='1.0'?>
 <!DOCTYPE platform_description SYSTEM "surfxml.dtd">
 <platform_description>
 <?xml version='1.0'?>
 <!DOCTYPE platform_description SYSTEM "surfxml.dtd">
 <platform_description>

+  <!-- ljlkj -->

   <cpu name="Tremblay" power="98.094999999999999"/>
   <cpu name="Jupiter" power="76.296000000000006"/>
   <cpu name="Fafard" power="76.296000000000006"/>
   <cpu name="Tremblay" power="98.094999999999999"/>
   <cpu name="Jupiter" power="76.296000000000006"/>
   <cpu name="Fafard" power="76.296000000000006"/>

diff --git a/src/msg/deployment.c b/src/msg/deployment.c
index dc8e961..4f61e3a 100644 (file)
--- a/src/msg/deployment.c
+++ b/src/msg/deployment.c
@@ -47,7 +47,16 @@ static void parse_process_finalize(void)
  * \brief An application deployer.
  *
  * Creates the process described in \a file.
  * \brief An application deployer.
  *
  * Creates the process described in \a file.

- * @param file a file containing an XML description of the application.
+ * \param file a filename of a xml description of the application. This file 
+ * follows this DTD :
+ *
+ *     \include surfxml.dtd
+ *
+ * Here is a small example of such a platform 
+ *
+ *     \include small_deployment.xml
+ *
+ * Have a look in the directory examples/msg/ to have a bigger example.

  */
 void MSG_launch_application(const char *file) 
 {
  */
 void MSG_launch_application(const char *file) 
 {