X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/70e5631fa1d3259796036151f5a5c8541132c5c8..895710d49f77179d9893bc76b3e31b69fae638af:/examples/s4u/README.doc

diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index 09cfb460c2..f4f51c2487 100644
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -58,7 +58,8 @@ TODO: document here the examples about plugins
   - <b>Kill actors</b>.
     @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n
     Actors can forcefully stop other actors with the @ref
-    simgrid::s4u::Actor::kill() method.
+    simgrid::s4u::Actor::kill(void) or the @ref
+    simgrid::s4u::Actor::kill(aid_t) methods.
 
   - <b>Controling the actor life cycle from the XML</b>.
     @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp 
@@ -212,6 +213,10 @@ result in short reads and short write, as in reality.
 
 @section s4u_ex_platf Interacting with the platform
 
+ - <b>Retrieving the list of hosts matching a given criteria</b>.
+   @ref examples/s4u/engine-filtering/s4u-engine-filtering.cpp\n
+   Filtering the actors that match a given criteria is rather simple.
+
  - <b>User-defined properties</b>.
    @ref examples/s4u/platform-properties/s4u-platform-properties.cpp and 
    @ref examples/s4u/platform-properties/s4u-platform-properties_d.xml and
@@ -227,11 +232,29 @@ result in short reads and short write, as in reality.
 
 @section s4u_ex_energy Simulating the energy consumption
 
+  - <b>Describing the energy profiles in the platform</b>
+    @ref examples/platforms/energy_platform.xml \n
+    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 instanciation matches your target platform.
+
   - <b>Consumption due to the CPU</b> 
     @ref examples/s4u/energy-exec/s4u-energy-exec.cpp \n
     This example shows how to retrieve the amount of energy consumed
     by the CPU during computations, and the impact of the pstate.
 
+  - <b>Consumption due to the network</b>
+    @ref examples/s4u/energy-link/s4u-energy-link.cpp
+    This example shows how to retrieve and display the energy consumed
+    by the network during communications.
+
+  - <b>Modeling the shutdown and boot of hosts</b>
+    @ref examples/s4u/energy-boot/platform_boot.xml
+    @ref examples/s4u/energy-boot/s4u-energy-boot.cpp\n
+    Simple example of model of model for the energy consumption during
+    the host boot and shutdown periods.
+
 @section s4u_ex_tracing Tracing and visualization features
 
 Tracing can be activated by various configuration options which
@@ -298,19 +321,23 @@ than the previous examples.
 @example examples/s4u/async-wait/s4u-async-wait.cpp
 @example examples/s4u/async-waitall/s4u-async-waitall.cpp
 @example examples/s4u/async-waitany/s4u-async-waitany.cpp
+@example examples/s4u/app-bittorrent/s4u-bittorrent.cpp
+@example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
+@example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
+@example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
+@example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 @example examples/s4u/dht-chord/s4u-dht-chord.cpp
+@example examples/s4u/engine-filtering/s4u-engine-filtering.cpp
+@example examples/s4u/energy-boot/platform_boot.xml
+@example examples/s4u/energy-boot/s4u-energy-boot.cpp
+@example examples/s4u/energy-exec/s4u-energy-exec.cpp
+@example examples/s4u/energy-link/s4u-energy-link.cpp
 @example examples/s4u/exec-basic/s4u-exec-basic.cpp
 @example examples/s4u/exec-async/s4u-exec-async.cpp
 @example examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
 @example examples/s4u/exec-monitor/s4u-exec-monitor.cpp
 @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
 @example examples/s4u/exec-remote/s4u-exec-remote.cpp 
-@example examples/s4u/app-bittorrent/s4u-bittorrent.cpp
-@example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
-@example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
-@example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
-@example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
-@example examples/s4u/energy-exec/s4u-energy-exec.cpp
 @example examples/s4u/io-file-system/s4u-io-file-system.cpp
 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 @example examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp
@@ -323,4 +350,4 @@ than the previous examples.
 @example examples/platforms/energy_platform.xml
 @example examples/platforms/prop.xml
 
-*/
\ No newline at end of file
+*/