Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid

[simgrid.git] / doc / doxygen / platform.doc

diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc
index 5564c83..109d3cb 100644 (file)
--- a/doc/doxygen/platform.doc
+++ b/doc/doxygen/platform.doc
@@ -361,12 +361,27 @@ unset.
     availability. Similar to <b>hosts</b> attribute. 
 \li <b>state_file</b>: Allow you to use a file as input for states.
     Similar to <b>hosts</b> attribute. 
+\li <b>loopback_bw </b>: bandwidth for loopback (if any). See <b>link</b>
+    section for syntax/details. If both loopback_* attributes are omitted,
+    no loopback link is created and all intra-node communication will 
+    use the main network link of the node. Loopback link is a <b>FATPIPE</b>.
+\li <b>loopback_lat </b>: latency for loopback (if any). See <b>link</b>
+    section for syntax/details. See loopback_bw for more info.
+\li <b>topology </b>: network topology to use. For now SimGrid supports FLAT 
+     (default, with or without backbone, as described before), 
+     <a href="http://en.wikipedia.org/wiki/Torus_interconnect">TORUS
+     </a> and FAT_TREE attributes for this tag.
+\li <b>topo_parameters </b>: specific parameters to pass for the topology 
+     defined in the topology tag. For torus networks, comma-separated list of 
+    the number of nodes in each dimension of the torus. For fat trees, refer to
+    \ref AsClusterFatTree "AsClusterFatTree documentation".
+
 
 the router name is defined as the resulting String in the following
 java line of code: 
 
 @verbatim
-router_name = prefix + clusterId + router_ + suffix;
+router_name = prefix + clusterId + _router + suffix;
 @endverbatim
 
 
@@ -383,11 +398,11 @@ The second examples creates one router and 100 machines, which names
 are the following:
 \verbatim
 c-my_cluster_1_router.me
-c-0.my_cluster_1.me
-c-1.my_cluster_1.me
-c-2.my_cluster_1.me
+c-0.me
+c-1.me
+c-2.me
 ...
-c-99.my_cluster_1.me
+c-99.me
 \endverbatim
 
 \subsubsection pf_peer peer
@@ -622,12 +637,14 @@ to define additional information on this storage_type following the
 attribute/value schema. You may want to use it to give information to
 the tool you use for rendering your simulation, for example.
 
+\verbatim
 <storage_type id="single_HDD" model="linear_no_lat" size="4000" content_type="txt_unix">
   <model_prop id="Bwrite" value="30MBps" />
   <model_prop id="Bread" value="100MBps" />
   <model_prop id="Bconnection" value="150MBps" />
   <b><prop id="Brand" value="Western Digital" /></b>
 </storage_type>
+\endverbatim
 
 \subsubsection pf_sto_st storage
 
@@ -635,8 +652,9 @@ the tool you use for rendering your simulation, for example.
 \li <b>id (mandatory)</b>: the identifier of the storage to be used
     when referring to it. 
 \li <b>typeId (mandatory)</b>: the identifier of the storage_type that
-    this storage  belongs to. 
-
+    this storage belongs to. 
+\li <b>attach (mandatory)</b>: the host (name) to which the storage is 
+       attached to.
 
 \subsubsection pf_sto_mo mount
 
@@ -950,7 +968,7 @@ Note that when using route to give topological information, you have
 to give routes with one link only in it, as SimGrid needs to know
 which host are at the end of the link.
 
-\subsubsection pf_byro bypassASroute
+\subsubsection pf_byASro bypassASroute
 
 <b>Note : bypassASroute and bypassRoute are under rewriting to perform
 better ; so you may not use it yet</b> As said before, once you choose