Merge branch 'master' into adrien

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

diff --git a/docs/source/Tutorial_Algorithms.rst b/docs/source/Tutorial_Algorithms.rst
index e8420dd..2bb09ed 100644 (file)
--- a/docs/source/Tutorial_Algorithms.rst
+++ b/docs/source/Tutorial_Algorithms.rst
@@ -12,7 +12,7 @@ execute user-provided functions. The actors have to explicitly use the
 S4U interface to express their computation, communication, disk usage
 and other |Activities|_, so that they get reflected within the
 simulator. These activities take place on **Resources** (|Hosts|_,
 S4U interface to express their computation, communication, disk usage
 and other |Activities|_, so that they get reflected within the
 simulator. These activities take place on **Resources** (|Hosts|_,

-|Links|_, |Storages|_). SimGrid predicts the time taken by each
+|Links|_, |Disks|_). SimGrid predicts the time taken by each

 activity and orchestrates accordingly the actors waiting for the
 completion of these activities.
 
 activity and orchestrates accordingly the actors waiting for the
 completion of these activities.
 


@@ -33,8 +33,8 @@ between communicating actors.
 .. |Links| replace:: **Links**
 .. _Links: app_s4u.html#s4u-link
 
 .. |Links| replace:: **Links**
 .. _Links: app_s4u.html#s4u-link
 

-.. |Storages| replace:: **Storages**
-.. _Storages: app_s4u.html#s4u-storage
+.. |Disks| replace:: **Disks**
+.. _Disks: app_s4u.html#s4u-disk

 
 .. |VirtualMachines| replace:: **VirtualMachines**
 .. _VirtualMachines: app_s4u.html#s4u-virtualmachine
 
 .. |VirtualMachines| replace:: **VirtualMachines**
 .. _VirtualMachines: app_s4u.html#s4u-virtualmachine


@@ -85,7 +85,7 @@ the opportunity to improve this scheme.
 The Actors
 ..........
 
 The Actors
 ..........
 

-Let's start with the code of the worker. It is represented by the
+Let's start with the code of the master. It is represented by the

 *master* function below. This simple function takes at least 3
 parameters (the amount of tasks to dispatch, their computational size
 in flops to compute and their communication size in bytes to
 *master* function below. This simple function takes at least 3
 parameters (the amount of tasks to dispatch, their computational size
 in flops to compute and their communication size in bytes to


@@ -211,6 +211,16 @@ informative messages.
    :append: $$$
    :dedent: 2
 
    :append: $$$
    :dedent: 2
 

+Each example included in the SimGrid distribution comes with a `tesh`
+file that presents how to start the example once compiled, along with
+the expected output. These files are used for the automatic testing of
+the framework, but can be used to see the examples' output without
+compiling them. See e.g. the file
+`examples/s4u/app-masterworkers/s4u-app-masterworkers.tesh <https://framagit.org/simgrid/simgrid/-/blob/master/examples/s4u/app-masterworkers/s4u-app-masterworkers.tesh>`_.
+Lines starting with `$` are the commands to execute;
+lines starting with `>` are the expected output of each command while
+lines starting with `!` are configuration items for the test runner.
+

 
 Improve it Yourself
 -------------------
 
 Improve it Yourself
 -------------------