Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Tutorial: A word about those nasty tesh files that you have in the examples
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Sat, 12 Sep 2020 14:44:26 +0000 (16:44 +0200)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Sat, 12 Sep 2020 14:44:26 +0000 (16:44 +0200)
docs/source/Tutorial_Algorithms.rst

index cbb9a8c..2bb09ed 100644 (file)
@@ -211,6 +211,16 @@ informative messages.
    :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
 -------------------