diff --git a/doc/developer/advance.tex b/doc/developer/advance.tex
index d69576d0ef2875d265d22318d27f0e216022a4ab..e275932216d8a6a094f3bf7b4d436882d18a6405 100644
--- a/doc/developer/advance.tex
+++ b/doc/developer/advance.tex
@@ -988,7 +988,7 @@ file, run it only once.
& \textit{None}
\\
& \texttt{FILTER}\nscodeidxdef{Test!Directive}{FILTER}
-& Command reading the standard input used to filter results. In such a command, the variable \texttt{@PTEST\_ORACLE@} is set to the basename of the oracle.
+& Command reading the standard input used to filter results. In such a command, the predefined macro \texttt{@PTEST\_ORACLE@} is set to the basename of the oracle.
& \textit{None}
\\
& \texttt{MODULE}\nscodeidxdef{Test!Directive}{MODULE}
@@ -1154,7 +1154,7 @@ or
\texttt{@macro-name@} in a \texttt{CMD}, \texttt{LOG}, \texttt{OPT},
\texttt{STDOPT} or \texttt{EXECNOW} directive at this configuration level
or in any level below it will be replaced by \texttt{content}. Existing
- pre-defined macros are listed in section~\ref{sec:ptests-macros}.
+ predefined macros are listed in section~\ref{sec:ptests-macros}.
\item \texttt{MODULE}\nscodeidx{Test!Directive}{MODULE}
directive takes as argument the name of a \texttt{.cmxs}
module. It will then add a directive to compile this file with the
@@ -1169,18 +1169,17 @@ or
usable in a \texttt{test\_config}\codeidx{test\_config}
configuration file.
\item The \texttt{FILTER}\nscodeidx{Test!Directive}{FILTER} directive specifies
- a transformation on the test result files before the comparison to the the
- oracles.
+ a transformation on the test result files before the comparison to the oracles.
The filtering command read the result from the standard input and the oracle
will be compared with the standard output of that command.
- In such a directive, the \texttt{@PTEST\_ORACLE@} variable is set to the
+ In such a directive, the predefined macro \texttt{@PTEST\_ORACLE@} is set to the
basename of the oracle.
- That allows to perform a \texttt{diff} command with the oracle of another
+ That allows running a \texttt{diff} command with the oracle of another
test configuration:
\begin{code}
- FILTER: diff --new-file @PTEST_DIR@/oracle_configuration/@PTEST_ORACLE@
+ FILTER: diff --new-file @PTEST_DIR@/oracle_configuration/@PTEST_ORACLE@ -
\end{code}
- Chaining multiple filter commands is possible in defining several \texttt{FILTER} directives (they are applied in the reverse order),
+ Chaining multiple filter commands is possible by defining several \texttt{FILTER} directives (they are applied in the reverse order),
and an empty command drops the previous \texttt{FILTER} directives.
\end{itemize}
diff --git a/ptests/ptests.ml b/ptests/ptests.ml
index d50104b0c16788387089c3c3609ab2d7915d074d..5b1478eeb934c3ad8192bda11c4b22724318b429 100644
--- a/ptests/ptests.ml
+++ b/ptests/ptests.ml
@@ -172,7 +172,7 @@ let dir_config_file = "test_config"
the pattern [test_file_regexp] will be considered as test files *)
let test_file_regexp = ".*\\.\\(c\\|i\\)$"
-(* Splits the command string to extract the command name to the parameters
+(* Splits the command string to separate the command name from the parameters
[let cmd_name,param=command_partition cmd in assert cmd=cmd_name^param]
*)
let command_partition =
@@ -332,7 +332,7 @@ let example_msg =
EXECNOW: ([LOG|BIN] <file>)+ <command> @[<v 0># Defines the command to execute to build a 'LOG' (textual) 'BIN' (binary) targets.@ \
# Note: the textual targets are compared to oracles.@]@ \
MODULE: <module>... @[<v 0># Compile the module and adds the corresponding '-load-module' option to all sub-test commands.@]@ \
- LOG: <file>... @[<v 0># Defines dune targets built by the next sub-test command.@]@ \
+ LOG: <file>... @[<v 0># Defines targets built by the next sub-test command.@]@ \
CMD: <command> @[<v 0># Defines the command to execute for all tests in order to get results to be compared to oracles.@]@ \
OPT: <options> @[<v 0># Defines a sub-test using the 'CMD' definition: <command> <options>@]@ \
STDOPT: +<extra> @[<v 0># Defines a sub-test and append the extra to the current option.@]@ \
@@ -340,25 +340,25 @@ let example_msg =
EXIT: <number> @[<v 0># Defines the exit code required for the next sub-test commands.@]@ \
FILTER: <cmd> @[<v 0># Performs a transformation on the test result files before the comparison from the oracles.@ \
# The oracle will be compared from the standard output of the command: cat <test-output-file> | <cmd> .@ \
- # Chaining multiple filter commands is possible in defining several FILTER directives.@ \
+ # Chaining multiple filter commands is possible by defining several FILTER directives.@ \
# An empty command drops the previous FILTER directives.@ \
- # Note: in such a command, the @@PTEST_ORACLE@@ variable is set to the basename of the oracle.@ \
- # That allows to perform a 'diff' command with the oracle of another test configuration:@ \
+ # Note: in such a command, the @@PTEST_ORACLE@@ macro is set to the basename of the oracle.@ \
+ # This allows running a 'diff' command with the oracle of another test configuration:@ \
# FILTER: diff --new-file @@PTEST_DIR@@/oracle_configuration/@@PTEST_ORACLE@@ @]@ \
TIMEOUT: <delay> @[<v 0># Set a timeout for all sub-test.@]@ \
NOFRAMAC: @[<v 0># Drops previous sub-test definitions and considers that there is no defined default sub-test.@]@ \
GCC: @[<v 0># Deprecated.@]@ \
- MACRO: <name> <def> @[<v 0># set a definition to the variable @@<name>@@.@]@ \
+ MACRO: <name> <def> @[<v 0># Set a definition to the macro @@<name>@@.@]@ \
@]@ \
@[<v 1>\
- Some variables can be used in test command:@ \
+ Some predefined macros can be used in test commands:@ \
@@PTEST_DIR@@ # Dirname of the test file.@ \
@@PTEST_FILE@@ # Substituted by the test filename.@ \
@@PTEST_NAME@@ # Basename of the test file.@ \
@@PTEST_NUMBER@@ # Test command number.@ \
@@PTEST_CONFIG@@ # Test configuration suffix.@ \
@@PTEST_RESULT@@ # Shorthand alias to @@PTEST_DIR@@/result@@PTEST_CONFIG@@ (the result directory dedicated to the tested configuration).@ \
- @@PTEST_ORACLE@@ # Basename of the current oracle file (variable only usable in FILTER directives).@ \
+ @@PTEST_ORACLE@@ # Basename of the current oracle file (macro only usable in FILTER directives).@ \
@[<v 1>\
Examples:@ \
ptests@ \