From: Augustin Degomme <degomme@idpann.imag.fr>
Date: Mon, 7 Apr 2014 14:05:04 +0000 (+0200)
Subject: also document torus networks
X-Git-Tag: v3_11~137
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/0afa354891d33f7fb103587b99cca779cf206019?ds=sidebyside

also document torus networks
---

diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc
index 082c96bb20..b9752952fe 100644
--- a/doc/doxygen/platform.doc
+++ b/doc/doxygen/platform.doc
@@ -364,9 +364,16 @@ unset.
 \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. 
+    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 bb_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) or 
+     <a href="http://en.wikipedia.org/wiki/Torus_interconnect">TORUS
+     </a> 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.
 
 
 the router name is defined as the resulting String in the following