Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ignore MSG and friends on sonar
[simgrid.git] / examples / README.rst
index bf2135b..810c7b9 100644 (file)
@@ -4,8 +4,8 @@
 .. documentation, but it should remain readable directly.
 
 
-S4U Examples
-************
+Examples
+********
 
 SimGrid comes with an extensive set of examples, documented on this
 page. Most of them only demonstrate one single feature, with some
@@ -22,12 +22,12 @@ A good way to bootstrap your own project is to copy and combine some
 of the provided examples to constitute the skeleton of what you plan
 to simulate.
 
+.. _s4u_ex_actors:
+
 ===========================
 Actors: the Active Entities
 ===========================
 
-.. _s4u_ex_actors:
-
 Starting and Stoping Actors
 ---------------------------
 
@@ -360,6 +360,8 @@ Executions on the CPU
 
        .. example-tab:: examples/platforms/energy_platform.xml
 
+.. _s4u_ex_disk_io:
+
 I/O on Disks and Files
 ----------------------
 
@@ -405,22 +407,29 @@ result in short reads and short write, as in reality.
 Classical synchronization objects
 ---------------------------------
 
- - **Mutex:**
-   Shows how to use simgrid::s4u::Mutex synchronization objects.
+ - **Barrier:**
+   Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
 
    .. tabs::
 
-      .. example-tab:: examples/s4u/synchro-mutex/s4u-synchro-mutex.cpp
+      .. example-tab:: examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp
 
- - **Barrier:**
-   Shows how to use simgrid::s4u::Barrier synchronization objects.
+ - **Condition variable:**
+   Shows how to use :cpp:type:`simgrid::s4u::ConditionVariable` synchronization objects.
 
    .. tabs::
 
-      .. example-tab:: examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp
+      .. example-tab:: examples/s4u/synchro-condition-variable/s4u-synchro-condition-variable.cpp
+
+ - **Mutex:**
+   Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
+
+   .. tabs::
+
+      .. example-tab:: examples/s4u/synchro-mutex/s4u-synchro-mutex.cpp
 
  - **Semaphore:**
-   Shows how to use simgrid::s4u::Semaphore synchronization objects.
+   Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
 
    .. tabs::