kill the C version of tesh (now unused). RIP :(

[simgrid.git] / tools / tesh / tesh.1

diff --git a/tools/tesh/tesh.1 b/tools/tesh/tesh.1
index 35a02ca..7dee6bb 100644 (file)
--- a/tools/tesh/tesh.1
+++ b/tools/tesh/tesh.1
@@ -1,22 +1,28 @@
-.\" Manpage for tesh
+.\" Manpage for tesh, the TEsting SHell.
+.\" 
+.\" To read it locally (when not installed): 
+.\"   man ./tesh.1
+.\"

 .TH tesh 1 "10 Oct 2012" "1.0" "tesh man page"
 .SH NAME
 tesh \- testing shell
 .SH SYNOPSIS
 .TH tesh 1 "10 Oct 2012" "1.0" "tesh man page"
 .SH NAME
 tesh \- testing shell
 .SH SYNOPSIS

-.B ls
+.B tesh

 [\fIOPTION\fR]... [\fIFILE\fR]...
 .SH DESCRIPTION
 [\fIOPTION\fR]... [\fIFILE\fR]...
 .SH DESCRIPTION

-This is the TESH tool. It constitutes a testing shell, ie a sort of shell specialized to run tests. The list of actions to take is parsed from files files called testsuite. 
+This is the TESH tool. It constitutes a testing shell, ie a sort of shell specialized to run tests. The list of actions to take is parsed from files files called testsuite.

 .SH OPTIONS
 .SH OPTIONS

-  --cd some/directory: ask tesh to switch the working directory before
-                       launching the tests
-  --setenv var=value: set a specific environment variable
+  --cd some/directory : ask tesh to switch the working directory before
+                        launching the tests
+  --setenv var=value  : set a specific environment variable
+  --cfg arg           : add parameter --cfg=arg to each command line
+  --enable-coverage   : ignore output lines starting with "profiling:"

 .SH TESH FILE SYNTAX
 Here is the syntax of these files:
 
 The kind of each line is given by the first char (the second char should be
 blank and is ignored):
 .SH TESH FILE SYNTAX
 Here is the syntax of these files:
 
 The kind of each line is given by the first char (the second char should be
 blank and is ignored):

- 
+

  `$' command to run in foreground
  `&' command to run in background
  `<' input to pass to the command
  `$' command to run in foreground
  `&' command to run in background
  `<' input to pass to the command


@@ -63,7 +69,7 @@ implemented yet in tesh. This is a bit restrictive, but well, patch
 welcome...
 
 The situation in which it is mainly problematic is to create a
 welcome...
 
 The situation in which it is mainly problematic is to create a

-temporary file. The solution is to use the "mkfile" buildin command,
+temporary file. The solution is to use the "mkfile" built-in command,

 as in the following example:
 $ mkfile myFile
 > some content
 as in the following example:
 $ mkfile myFile
 > some content


@@ -94,7 +100,7 @@ cannot timeout.
 .SH OUTPUT
 By default, the commands output is matched against the one expected,
 and an error is raised on discrepancy. Metacommands to change this:
 .SH OUTPUT
 By default, the commands output is matched against the one expected,
 and an error is raised on discrepancy. Metacommands to change this:

- "output ignore"  -> output completely discarded 
+ "output ignore"  -> output completely discarded

  "output display" -> output displayed (but not verified)
  "output sort"    -> sorts the display before verifying it (see below)
 .SH SORTING OUTPUT
  "output display" -> output displayed (but not verified)
  "output sort"    -> sorts the display before verifying it (see below)
 .SH SORTING OUTPUT


@@ -102,20 +108,20 @@ Sorting the output seems to be a strange idea, but it is mandatory in
 SimGrid since the processes run out of order at any scheduling point
 (ie, every processes ready to run at simulated time t run in
 parallel). To ensure that the simulator outputs still match, we have
 SimGrid since the processes run out of order at any scheduling point
 (ie, every processes ready to run at simulated time t run in
 parallel). To ensure that the simulator outputs still match, we have

-to sort the output back before comparing it. 
+to sort the output back before comparing it.

 
 

-We expect the simulators to run with that log formating argument:
-   -log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n
+We expect the simulators to run with that log formatting argument:
+   --log=root.fmt:[%10.6r]%e(%i:%P@%h)%e%m%n

 Then, tesh sorts string on the 19 first chars only, and is stable when
 line beginnings are equal. This should ensure that:
  (1) tesh is effective (no false positive, no false negative)
 Then, tesh sorts string on the 19 first chars only, and is stable when
 line beginnings are equal. This should ensure that:
  (1) tesh is effective (no false positive, no false negative)

- (2) scheduling points are separated from each other 
- (3) at each scheduling point, processes are separated from each other 
+ (2) scheduling points are separated from each other
+ (3) at each scheduling point, processes are separated from each other

  (4) the order of what a given process says at a given scheduling
      point is preserved.
  (4) the order of what a given process says at a given scheduling
      point is preserved.

-     
+

 This is of course very SimGrid oriented, breaking the generality of
 This is of course very SimGrid oriented, breaking the generality of

-tesh, but who cares, actually?     
+tesh, but who cares, actually?

 
 If you want to change the length of the prefix used for the sort,
 simply specify it after the output sort directive, like this:
 
 If you want to change the length of the prefix used for the sort,
 simply specify it after the output sort directive, like this: