python3-dev is another dependency of the Python bindings

[simgrid.git] / docs / source / XML_reference.rst

diff --git a/docs/source/XML_reference.rst b/docs/source/XML_reference.rst
index 9435ecf..dad879d 100644 (file)
--- a/docs/source/XML_reference.rst
+++ b/docs/source/XML_reference.rst
@@ -26,6 +26,7 @@ Here is the complete list of all existing tags in the DTD:
 :ref:`pf_tag_bypassRoute`: tweeking the routing (advanced tag). |br|
 :ref:`pf_tag_bypassZoneRoute`: tweeking the routing (expert-only tag). |br|
 :ref:`pf_tag_cabinet`: building clusters manually from the XML (deprecated, please use the C++ API). |br|
+:ref:`pf_tag_cluster`: building a cluster (aka, a full zone in one tag only). |br|
 :ref:`pf_tag_config`: pass simulation parameters from the XML file. |br|
 :ref:`pf_tag_disk`: storage resource. |br|
 :ref:`pf_tag_host`: computing resource. |br|
@@ -131,10 +132,10 @@ name of the flag and ``value`` is what it has to be set to.
    <!DOCTYPE platform SYSTEM "https://simgrid.org/simgrid.dtd">
    <platform version = "4.1">
      <config>
-       <prop id = "maxmin/precision" value = "0.000010" />
+       <prop id = "precision/work-amount" value = "0.000010" />
        <prop id = "cpu/optim" value = "TI" />
        <prop id = "network/model" value = "SMPI" />
-       <prop id = "smpi/bw-factor" value = "65472:0.940694;15424:0.697866;9376:0.58729" />
+       <prop id = "network/bandwidth-factor" value = "65472:0.940694;15424:0.697866;9376:0.58729" />
      </config>
 
      <!-- The rest of your platform -->
@@ -192,13 +193,13 @@ We provide an example model of file system as a plugin, (sparsely) documented in
 A host is the computing resource on which an actor can run. See :cpp:class:`simgrid::s4u::Host`.
 
 **Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e., zones containing neither inner zones nor clusters) |br|
-**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_disk` |br|
+**Children tags:** :ref:`pf_tag_prop`, :ref:`pf_tag_disk` |br|
 **Attributes:**
 
 :``id``: Host name.
    Must be unique over the whole platform.
 :``speed``: Computational power (per core, in flop/s).
-   If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`howto_dvfs`).
+   If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`API_s4u_Host_dvfs`).
 :``core``: Amount of cores (default: 1).
    See :ref:`howto_multicore`.
 :``availability_file``:
@@ -246,7 +247,7 @@ A host is the computing resource on which an actor can run. See :cpp:class:`simg
 :``coordinates``: Vivaldi coordinates (meaningful for Vivaldi zones only).
    See :ref:`pf_tag_peer`.
 :``pstate``: Initial pstate (default: 0, the first one).
-   See :ref:`howto_dvfs`.
+   See :ref:`API_s4u_Host_dvfs`.
 
 -------------------------------------------------------------------------------
 
@@ -324,8 +325,8 @@ hyperlinks in an `hypergraph <https://en.wikipedia.org/wiki/Hypergraph>`_.
       8.0 60000000
       LOOPAFTER 12.0
 
-   - At time t = 4, the bandwidth is of 40 MBps.
-   - At time t = 8, it raises to 60MBps.
+   - At time t = 4, the bandwidth is of 40 Mb/s.
+   - At time t = 8, it raises to 60 Mb/s.
    - At time t = 24, it drops at 40 MBps again.
 
    If your profile does not contain any LOOPAFTER line, then it will
@@ -399,7 +400,7 @@ and a download link.
 :``id``: Name of the host. Must be unique on the whole platform.
 :``speed``: Computational power (in flop/s).
 
-   If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`howto_dvfs`).
+   If you use DVFS, provide a comma-separated list of values for each pstate (see :ref:`API_s4u_Host_dvfs`).
 :``bw_in``: Bandwidth of the private downstream link, along with its
            unit. See :ref:`pf_tag_link`.
 :``bw_out``: Bandwidth of the private upstream link, along with its
@@ -456,12 +457,12 @@ the plugins.
 From your code, you can interact with these properties using the
 following functions:
 
-- Actor: :cpp:func:`simgrid::s4u::Actor::get_property` or :cpp:func:`MSG_process_get_property_value`
+- Actor: :cpp:func:`simgrid::s4u::Actor::get_property`
 - Cluster: this is a zone, see below.
 - Disk: :cpp:func:`simgrid::s4u::Disk::get_property`
-- Host: :cpp:func:`simgrid::s4u::Host::get_property` or :cpp:func:`MSG_host_get_property_value`
+- Host: :cpp:func:`simgrid::s4u::Host::get_property`
 - Link: :cpp:func:`simgrid::s4u::Link::get_property`
-- Zone: :cpp:func:`simgrid::s4u::NetZone::get_property` of :cpp:func:`MSG_zone_get_property_value`
+- Zone: :cpp:func:`simgrid::s4u::NetZone::get_property`
 
 **Parent tags:** :ref:`pf_tag_actor`, :ref:`pf_tag_config`, :ref:`pf_tag_cluster`, :ref:`pf_tag_host`,
 :ref:`pf_tag_link`, :ref:`pf_tag_disk`,:ref:`pf_tag_zone` |br|
@@ -554,7 +555,7 @@ More detail can be found in the following sections :ref:`pf_routes` and :ref:`pf
 :``gw_src``: Netpoint (within src zone) from which this route starts. Must be an existing host/router.
 :``gw_dst``: Netpoint (within dst zone) to which this route leads. Must be an existing host/router.
 :``symmetrical``: Whether this route is symmetrical, ie, whether we are defining the route ``dst -> src`` at the same
-                 time. Valid values: ``yes``, ``no``, ``YES``, ``NO``. 
+                 time. Valid values: ``yes``, ``no``, ``YES``, ``NO``.
 
 -------------------------------------------------------------------------------
 
@@ -605,7 +606,7 @@ to experts.
 :``gw_src``: Netpoint (within src zone) from which this route starts. Must be an existing host/router.
 :``gw_dst``: Netpoint (within dst zone) to which this route leads. Must be an existing host/router.
 :``symmetrical``: Whether this route is symmetrical, ie, whether we are defining the route ``dst -> src`` at the same
-                 time. Valid values: ``yes``, ``no``, ``YES``, ``NO``. 
+                 time. Valid values: ``yes``, ``no``, ``YES``, ``NO``.
 
 -------------------------------------------------------------------------------
 
@@ -680,5 +681,5 @@ Specify the up and down private links of a given host, which must be in a Cluste
 
 
 .. |br| raw:: html
-     
+
    <br />