kill parts of the old doc that were converted

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

diff --git a/docs/source/platform_reference.rst b/docs/source/platform_reference.rst
index 77f81e7..c619cbc 100644 (file)
--- a/docs/source/platform_reference.rst
+++ b/docs/source/platform_reference.rst
@@ -10,6 +10,8 @@
    <br/>
    <br/>
 
+.. _platform_reference:
+   
 DTD Reference
 *************
 
@@ -49,7 +51,8 @@ can be configured this way.
    <!-- The rest of your platform -->
    </platform>
 
-
+|hr|
+   
 .. _pf_tag_host:
 
 ------------------------------------------------------------------
@@ -59,7 +62,7 @@ can be configured this way.
 An host is the computing resource on which an actor can execute. See :cpp:class:`simgrid::s4u::Host`.
 
 **Parent tags:** :ref:`pf_tag_zone` (only leaf zones, i.e. zones containing no inner zones nor clusters) |br|
-**Children tags:** :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br|
+**Children tags:** :ref:`pf_tag_mount`, :ref:`pf_tag_prop`, :ref:`pf_tag_storage` |br|
 **Attributes:**
 
 :``id``: Host name.
@@ -117,13 +120,19 @@ An host is the computing resource on which an actor can execute. See :cpp:class:
 :``pstate``: Initial pstate (default: 0, the first one).
    See :ref:`howto_dvfs`.
 
+|hr|
+   
 .. _pf_tag_link:
 
 ------------------------------------------------------------------
 <link>
 ------------------------------------------------------------------
 
-Network links can represent one-hop network connections. See :cpp:class:`simgrid::s4u::Link`.
+Network links can represent one-hop network connections (see
+:cpp:class:`simgrid::s4u::Link`). SimGrid links can be used to
+represent either a single wire, or to abstract a larger network
+interconnect in a single element. A single link can for example be
+used to model the transcontinental network.
 
 **Parent tags:** :ref:`pf_tag_zone` (both leaf zones and inner zones) |br|
 **Children tags:** :ref:`pf_tag_prop` |br|
@@ -223,7 +232,9 @@ Network links can represent one-hop network connections. See :cpp:class:`simgrid
       :ref:`pf_tag_link` are absolute values, but Availability
       profiles of :ref:`pf_tag_host` are ratio.
 :``state_file``: File containing the state profile. See :ref:`pf_tag_host`.
-   
+
+|hr|
+
 .. _pf_tag_peer:
 
 ------------------------------------------------------------------
@@ -265,8 +276,29 @@ and a download link.
 :``state_file``: File containing the state profile.
    See the full description in :ref:`pf_tag_host`
 
+|hr|
 
-   
+.. _pf_tag_platform:
+
+------------------------------------------------------------------
+<platform>
+------------------------------------------------------------------
+
+**Parent tags:** none (this is the root tag of every file) |br|
+**Children tags:** :ref:`pf_tag_config` (must come first),
+:ref:`pf_tag_cluster`, :ref:`pf_tag_cabinet`, :ref:`pf_tag_peer`,
+:ref:`pf_tag_zone`, :ref:`pf_tag_trace`, :ref:`pf_tag_trace_connect` |br|
+**Attributes:** 
+
+:``version``: Version of the DTD, describing the whole XML format.
+             This versionning allow future evolutions, even if we
+             avoid backward-incompatible changes. The current version
+             is **4.1**. The ``simgrid_update_xml`` program can
+             upgrade most of the past platform files to the recent
+             formalism.
+
+|hr|
+             
 .. _pf_tag_prop:
 
 ------------------------------------------------------------------
@@ -280,7 +312,13 @@ 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`
+- Cluster: this is a zone, see below.
 - Host: :cpp:func:`simgrid::s4u::Host::get_property` or :cpp:func:`MSG_host_get_property_value`
+- Link: :cpp:func:`simgrid::s4u::Link::get_property`
+- Storage: :cpp:func:`simgrid::s4u::Storage::get_property` or :cpp:func:`MSG_storage_get_property_value`
+- Zone: :cpp:func:`simgrid::s4u::Zone::get_property` of :cpp:func:`MSG_zone_get_property_value`
 
 **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_storage`, :ref:`pf_tag_zone` |br|
@@ -290,6 +328,8 @@ following functions:
 :``id``: Name of the defined property.
 :``value``: Value of the defined property.
 
+|hr|
+
 .. _pf_tag_router:
 
 ------------------------------------------------------------------
@@ -312,3 +352,7 @@ break the routes that are longer than 1 hop.
 .. |br| raw:: html
 
    <br />
+
+.. |hr| raw:: html
+
+   <hr />