From: Martin Quinson <martin.quinson@loria.fr>
Date: Tue, 9 Feb 2016 00:04:03 +0000 (+0100)
Subject: reflect the DTDv4 in the documentation
X-Git-Tag: v3_13~913
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/ade33a95aadc133741f314ef1861998043c5511e?hp=14dbe48f4f9623cf72fc207b7c2041b9f611972a;ds=sidebyside

reflect the DTDv4 in the documentation
---

diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc
index a43c273649..14910b22ce 100644
--- a/doc/doxygen/platform.doc
+++ b/doc/doxygen/platform.doc
@@ -35,10 +35,10 @@ available and very well tested.
 
 The XML checking is done based on the Document Type Definition (DTD) file,
 available at
-<a href="http://simgrid.gforge.inria.fr/simgrid.dtd">http://simgrid.gforge.inria.fr/simgrid.dtd</a>.
+<a href="http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd</a>.
 
 If you read the DTD, you should notice the following:
-\li The platform tags contain a version attribute; the current version is 3.
+\li The platform tags contain a version attribute; the current version is 4.
     This property might be used in the future to provide backwards
     compatibility.
 \li The DTD contains definitions for the two files used by SimGrid (i.e.,
@@ -206,8 +206,8 @@ and a separate text file whose syntax is exemplified below.
 #### Adding a trace file ####
 
 \verbatim
-<platform version="1">
-  <host id="bob" power="500000000" availability_file="bob.trace" />
+<platform version="4">
+  <host id="bob" power="500Gf" availability_file="bob.trace" />
 </platform>
 \endverbatim
 
@@ -241,8 +241,8 @@ It is also possible to specify whether the host is up or down by setting the
 #### Example: Expliciting the default value "ON" ####
 
 \verbatim
-<platform version="1">
-   <host id="bob" power="500000000" state="ON" />
+<platform version="4">
+   <host id="bob" power="500Gf" state="ON" />
 </platform>
 \endverbatim
 
@@ -259,8 +259,8 @@ of such a file is presented below.
 #### Adding a state file ####
 
 \verbatim
-<platform version="1">
-  <host id="bob" power="500000000" state_file="bob.fail" />
+<platform version="4">
+  <host id="bob" power="500Gf" state_file="bob.fail" />
 </platform>
 \endverbatim
 
@@ -1560,7 +1560,7 @@ Tag name        | Description | Documentation
 \verbatim
 <?xml version='1.0'?>
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
-<platform version="3">
+<platform version="4">
 <config id="General">
 	<prop id="maxmin/precision" value="0.000010"></prop>
 	<prop id="cpu/optim" value="TI"></prop>
@@ -1607,7 +1607,7 @@ each of them will then be usable.
 \verbatim
 <?xml version='1.0'?>
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
-<platform version="3">
+<platform version="4">
 	<AS id="main" routing="Full">
 		<include file="clusterA.xml"></include>
 		<include file="clusterB.xml"></include>
@@ -1753,16 +1753,16 @@ complicated in using it, here is an example of it:
 \verbatim
 <?xml version='1.0'?>
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
-<platform version="3">
+<platform version="4">
 
 <config id="General">
 	<prop id="network/coordinates" value="yes"></prop>
 </config>
  <AS  id="AS0"  routing="Vivaldi">
-	<host id="100030591" coordinates="25.5 9.4 1.4" power="1500000000.0" />
-	<host id="100036570" coordinates="-12.7 -9.9 2.1" power="730000000.0" />
+	<host id="100030591" coordinates="25.5 9.4 1.4" power="1.5Gf" />
+	<host id="100036570" coordinates="-12.7 -9.9 2.1" power="7.3Gf" />
 	...
-	<host id="100429957" coordinates="17.5 6.7 18.8" power="830000000.0" />
+	<host id="100429957" coordinates="17.5 6.7 18.8" power="8.3Gf" />
 	</AS>
 </platform>
 \endverbatim
@@ -1776,7 +1776,7 @@ That is for example what is commonly done when using peers (see Section \ref pf_
 \verbatim
 <?xml version='1.0'?>
 <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid.dtd">
-<platform version="3">
+<platform version="4">
 
 <config id="General">
 	<prop id="network/coordinates" value="yes"></prop>
@@ -1896,7 +1896,7 @@ FleXML parser are close to classical SAX parsers. It means that a
 well-formed SimGrid platform XML file might result in the following
 "events":
 
-  - start "platform_description" with attribute version="2"
+  - start "platform_description" with attribute version="4"
   - start "host" with attributes id="host1" power="1.0"
   - end "host"
   - start "host" with attributes id="host2" power="2.0"