X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0a63e497ca28d2176a61304e62050790cbda853c..1738c10ed9593cdd280ec4d911902cd282fb5317:/examples/README.rst

diff --git a/examples/README.rst b/examples/README.rst
index 32222e3a82..0b74ab5ae0 100644
--- a/examples/README.rst
+++ b/examples/README.rst
@@ -29,7 +29,7 @@ Actors: the Active Entities
 ===========================
 
 Starting and Stopping Actors
----------------------------
+----------------------------
 
   - **Creating actors:**
     Most actors are started from the deployment XML file, because this
@@ -440,6 +440,13 @@ Executions on the CPU
     computational kernels that span over several machines, such as a
     PDGEM and the other ScaLAPACK routines. Note that this only works
     with the "ptask_L07" host model (``--cfg=host/model:ptask_L07``).
+    
+    This example demonstrates several kind of parallel tasks: regular
+    ones, communication-only (without computation), computation-only
+    (without communication), synchronization-only (neither
+    communication nor computation). It also shows how to reconfigure a
+    task after its start, to change the amount of hosts it runs onto.
+    This allows to simulate malleable tasks.
 
     .. tabs::
 
@@ -449,7 +456,7 @@ Executions on the CPU
 
   - **Using Pstates on a host:**
     This example shows how define a set of pstates in the XML. The current pstate
-    of an host can then be accessed and changed from the program.
+    of a host can then be accessed and changed from the program.
 
     .. tabs::
 
@@ -644,14 +651,22 @@ Energy Simulation
 =================
 
   - **Describing the energy profiles in the platform:**
-    This platform file contains the energy profile of each links and
-    hosts, which is necessary to get energy consumption predictions.
-    As usual, you should not trust our example, and you should strive
-    to double-check that your instantiation matches your target platform.
+    The first platform file contains the energy profile of each links and
+    hosts for a wired network, which is necessary to get energy consumption
+    predictions. The second platform file is the equivalent for a wireless
+    network. As usual, you should not trust our example, and you should
+    strive to double-check that your instantiation matches your target
+    platform.
 
     .. tabs::
 
-       .. example-tab:: examples/platforms/energy_platform.xml
+       .. group-tab:: XML
+
+	  .. showfile:: examples/platforms/energy_platform.xml
+	     :language: xml
+
+	  .. showfile:: examples/platforms/wifi_energy.xml
+	     :language: xml
 
   - **Consumption due to the CPU:** 
     This example shows how to retrieve the amount of energy consumed
@@ -663,14 +678,22 @@ Energy Simulation
 
        .. example-tab:: examples/c/energy-exec/energy-exec.c
 
-  - **Consumption due to the network:**
+  - **Consumption due to the wired network:**
     This example shows how to retrieve and display the energy consumed
-    by the network during communications.
+    by the wired network during communications.
 
     .. tabs::
 
        .. example-tab:: examples/s4u/energy-link/s4u-energy-link.cpp
 
+  - **Consumption due to the wireless network:**
+    This example shows how to retrieve and display the energy consumed
+    by the wireless network during communications.
+
+    .. tabs::
+
+       .. example-tab:: examples/s4u/energy-wifi/s4u-energy-wifi.cpp
+
   - **Modeling the shutdown and boot of hosts:**
     Simple example of model of model for the energy consumption during
     the host boot and shutdown periods.
@@ -930,6 +953,34 @@ Model-Related Examples
          .. showfile:: examples/platforms/wifi.xml
             :language: xml
 
+===============
+Plugin Examples
+===============
+
+It is possible to extend SimGrid without modifying its internals by
+attaching code to the existing signals and by adding extra data to the
+simulation objects through extensions. How to do that is not exactly
+documented yet, and you should look for examples in the src/plugins
+directory.
+
+This section documents how the existing plugins can be used. Remember
+that you are very welcome to modify the plugins to fit your needs. It
+should be much easier than modifying the SimGrid kernel.
+
+  - **Monitoring the host load**
+
+    .. tabs::
+
+      .. example-tab:: examples/s4u/plugin-host-load/s4u-plugin-host-load.cpp
+
+      .. example-tab:: examples/c/plugin-host-load/plugin-host-load.c
+
+  - **Monitoring the link load**
+
+    .. tabs::
+
+      .. example-tab:: examples/s4u/plugin-link-load/s4u-plugin-link-load.cpp
+
 =======================
 Model-Checking Examples
 =======================