New signal: Actor::on_termination (when its code terminates)

[simgrid.git] / examples / s4u / README.rst

diff --git a/examples/s4u/README.rst b/examples/s4u/README.rst
index f751c6b..df88b03 100644 (file)
--- a/examples/s4u/README.rst
+++ b/examples/s4u/README.rst
@@ -31,6 +31,7 @@ to simulate.
 Actors: the Active Entities
 ===========================
 
 Actors: the Active Entities
 ===========================
 

+.. _s4u_ex_actors:

 
 Starting and Stoping Actors
 ---------------------------
 
 Starting and Stoping Actors
 ---------------------------


@@ -48,6 +49,7 @@ Starting and Stoping Actors
     of doing so, depending of whether you want your callback to be
     executed when a specific actor ends (with ```this_actor::on_exit()```)
     or whether it should be executed when any actor ends (with
     of doing so, depending of whether you want your callback to be
     executed when a specific actor ends (with ```this_actor::on_exit()```)
     or whether it should be executed when any actor ends (with

+    ```Actor::on_termination()```) or when it gets destroyed (with

     ```Actor::on_destruction()```)
 
     - |cpp| `examples/s4u/actor-exiting/s4u-actor-exiting.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-exiting/s4u-actor-exiting.cpp>`_
     ```Actor::on_destruction()```)
 
     - |cpp| `examples/s4u/actor-exiting/s4u-actor-exiting.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-exiting/s4u-actor-exiting.cpp>`_


@@ -307,7 +309,7 @@ Interacting with the Platform
    resources must be turned off and on again, and how to react to such
    failures in your code.
    
    resources must be turned off and on again, and how to react to such
    failures in your code.
    

-   |br| `examples/platforms/small_platform_with_failure.xml <https://framagit.org/simgrid/simgrid/tree/master/examples/platforms/small_platform_with_failure.xml>`_
+   |br| `examples/platforms/small_platform_failures.xml <https://framagit.org/simgrid/simgrid/tree/master/examples/platforms/small_platform_failures.xml>`_

    |br| The state profiles in `examples/platforms/profiles <https://framagit.org/simgrid/simgrid/tree/master/examples/platforms/profiles>`_
 
  - **Specifying speed profiles:** shows how to specify an external
    |br| The state profiles in `examples/platforms/profiles <https://framagit.org/simgrid/simgrid/tree/master/examples/platforms/profiles>`_
 
  - **Specifying speed profiles:** shows how to specify an external


@@ -406,7 +408,17 @@ Distributed Hash Tables (DHT)
     One of the most famous DHT protocol.
     |br| `examples/s4u/dht-chord/s4u-dht-chord.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/dht-chord/s4u-dht-chord.cpp>`_
 
     One of the most famous DHT protocol.
     |br| `examples/s4u/dht-chord/s4u-dht-chord.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/dht-chord/s4u-dht-chord.cpp>`_
 

-.. TODO:: document here the examples about plugins
+.. _s4u_ex_clouds:
+
+Simulating Clouds
+-----------------
+
+  - **Cloud basics**
+    This example starts some computations both on PMs and VMs, and
+    migrates some VMs around.
+    |br| `examples/s4u/cloud-simple/s4u-cloud-simple.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/cloud-simple/s4u-cloud-simple.cpp>`_
+
+.. TODO:: document here the examples about clouds and plugins

 
 =======================
 Model-Checking Examples
 
 =======================
 Model-Checking Examples


@@ -418,12 +430,12 @@ mode is rather experimental in SimGrid (as of v3.22). You should not
 enable it unless you really want to formally verify your applications:
 SimGrid is slower and maybe less robust when MC is enabled.
 
 enable it unless you really want to formally verify your applications:
 SimGrid is slower and maybe less robust when MC is enabled.
 

-  - **Failed assert**
+  - **Failing assert**

     In this example, two actors send some data to a central server,
     which asserts that the messages are always received in the same order.
     This is obviously wrong, and the model-checker correctly finds a
     counter-example to that assertion.
     In this example, two actors send some data to a central server,
     which asserts that the messages are always received in the same order.
     This is obviously wrong, and the model-checker correctly finds a
     counter-example to that assertion.

-    |br| `examples/s4u/mc-failed-assert/s4u-mc-failed-assert.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/mc-failed-assert/s4u-mc-failed-assert.cpp>`_
+    |br| `examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/mc-failing-assert/s4u-mc-failing-assert.cpp>`_

 
 .. |br| raw:: html
 
 
 .. |br| raw:: html