Skip to content
Snippets Groups Projects
Commit eb67ef5f authored by Virgile Prevosto's avatar Virgile Prevosto Committed by Valentin Perrelle
Browse files

[doc] Fix index entry for MODULE and clean up test directive entries

parent 39cd8ff7
No related branches found
No related tags found
No related merge requests found
...@@ -745,7 +745,7 @@ occurs currently in the following cases: ...@@ -745,7 +745,7 @@ occurs currently in the following cases:
\begin{example} \begin{example}
Test \texttt{tests/sparecode/calls.c} declares the following directives. Test \texttt{tests/sparecode/calls.c} declares the following directives.
\sscodeidx{Test}{Directive}{OPT} \nscodeidx{Test!Directive}{OPT}
\begin{listing-nonumber} \begin{listing-nonumber}
/* run.config /* run.config
OPT: -sparecode-analysis OPT: -sparecode-analysis
...@@ -895,59 +895,59 @@ the configuration header of a test (or a test suite). ...@@ -895,59 +895,59 @@ the configuration header of a test (or a test suite).
\textbf{Kind} & \textbf{Name} & \textbf{Specification} & \textbf{default}\\ \textbf{Kind} & \textbf{Name} & \textbf{Specification} & \textbf{default}\\
\hline \hline
\hline \multirow{4}{23mm}{\centering{Command}} \hline \multirow{4}{23mm}{\centering{Command}}
& \texttt{CMD}\sscodeidxdef{Test}{Directive}{CMD} & \texttt{CMD}\nscodeidxdef{Test!Directive}{CMD}
& Program to run & Program to run
& \texttt{./bin/toplevel.opt} & \texttt{./bin/toplevel.opt}
\\ \\
& \texttt{OPT}\sscodeidxdef{Test}{Directive}{OPT} & \texttt{OPT}\nscodeidxdef{Test!Directive}{OPT}
& Options given to the program & Options given to the program
& \texttt{-val -out -input -deps} & \texttt{-val -out -input -deps}
\\ \\
& \texttt{STDOPT}\sscodeidxdef{Test}{Directive}{STDOPT} & \texttt{STDOPT}\nscodeidxdef{Test!Directive}{STDOPT}
& Add and remove options from the default set & Add and remove options from the default set
& \textit{None} & \textit{None}
\\ \\
& \texttt{LOG}\sscodeidxdef{Test}{Directive}{LOG} & \texttt{LOG}\nscodeidxdef{Test!Directive}{LOG}
& Add an additional file to compare against an oracle & Add an additional file to compare against an oracle
& \textit{None} & \textit{None}
\\ \\
& \texttt{EXECNOW}\sscodeidxdef{Test}{Directive}{EXECNOW} & \texttt{EXECNOW}\nscodeidxdef{Test!Directive}{EXECNOW}
& Run a command before the following commands. When specified in a configuration & Run a command before the following commands. When specified in a configuration
file, run it only once. file, run it only once.
& \textit{None} & \textit{None}
\\ \\
& \texttt{EXEC}\sscodeidxdef{Test}{Directive}{EXEC} & \texttt{EXEC}\nscodeidxdef{Test!Directive}{EXEC}
& Similar to \texttt{EXECNOW}, but run it once per testing file. & Similar to \texttt{EXECNOW}, but run it once per testing file.
& \textit{None} & \textit{None}
\\ \\
& \texttt{MACRO}\sscodeidxdef{Test}{Directive}{MACRO} & \texttt{MACRO}\nscodeidxdef{Test!Directive}{MACRO}
& Define a new macro & Define a new macro
& \textit{None} & \textit{None}
\\ \\
& \texttt{FILTER}\sscodeidxdef{Test}{Directive}{FILTER} & \texttt{FILTER}\nscodeidxdef{Test!Directive}{FILTER}
& Command used to filter results & Command used to filter results
& \textit{None} & \textit{None}
\\ \\
& \texttt{MODULE}\sscodeidxdef{Test}{Directive}{FILTER} & \texttt{MODULE}\nscodeidxdef{Test!Directive}{MODULE}
& Register a dynamic module to be built and to be loaded with each subsequent & Register a dynamic module to be built and to be loaded with each subsequent
test test
& \textit{None} & \textit{None}
\\ \\
\hline \multirow{2}{23mm}{\centering{Test suite}} \hline \multirow{2}{23mm}{\centering{Test suite}}
& \texttt{DONTRUN}\sscodeidxdef{Test}{Directive}{DONTRUN} & \texttt{DONTRUN}\nscodeidxdef{Test!Directive}{DONTRUN}
& Do not execute this test & Do not execute this test
& \textit{None} & \textit{None}
\\ \\
& \texttt{FILEREG}\sscodeidxdef{Test}{Directive}{FILEREG} & \texttt{FILEREG}\nscodeidxdef{Test!Directive}{FILEREG}
& selects the files to test & selects the files to test
& \texttt{.*\bss.\bss(c|i\bss)} & \texttt{.*\bss.\bss(c|i\bss)}
\\ \\
\hline \multirow{2}{23mm}{\centering{Miscellaneous}} \hline \multirow{2}{23mm}{\centering{Miscellaneous}}
& \texttt{COMMENT}\sscodeidxdef{Test}{Directive}{COMMENT} & \texttt{COMMENT}\nscodeidxdef{Test!Directive}{COMMENT}
& Comment in the configuration & Comment in the configuration
& \textit{None} & \textit{None}
\\ \\
& \texttt{GCC}\sscodeidxdef{Test}{Directive}{GCC} & \texttt{GCC}\nscodeidxdef{Test!Directive}{GCC}
& Unused (compatibility only) & Unused (compatibility only)
& \textit{None} & \textit{None}
\\ \\
...@@ -998,7 +998,7 @@ the sequence above is read in order and defines a configuration level ...@@ -998,7 +998,7 @@ the sequence above is read in order and defines a configuration level
directive is found). No new test case is generated directive is found). No new test case is generated
if there is no further \texttt{OPT} directive. At a given if there is no further \texttt{OPT} directive. At a given
configuration level, the default value for directive configuration level, the default value for directive
\texttt{CMD}\sscodeidxdef{Test}{Directive}{CMD} is the last \texttt{CMD}\nscodeidx{Test!Directive}{CMD} is the last
\texttt{CMD} directive of the preceding configuration level. \texttt{CMD} directive of the preceding configuration level.
\item \texttt{LOG} adds a file to be compared against an oracle in the \item \texttt{LOG} adds a file to be compared against an oracle in the
next \texttt{OPT} directive. Several files can be monitored from a single next \texttt{OPT} directive. Several files can be monitored from a single
...@@ -1012,7 +1012,7 @@ the sequence above is read in order and defines a configuration level ...@@ -1012,7 +1012,7 @@ the sequence above is read in order and defines a configuration level
configuration level, they correspond to different test cases. The configuration level, they correspond to different test cases. The
\texttt{OPT} directive(s) of a given configuration level replace(s) \texttt{OPT} directive(s) of a given configuration level replace(s)
the ones of the preceding level. the ones of the preceding level.
\item The \texttt{STDOPT}\sscodeidxdef{Test}{Directive}{STDOPT} \item The \texttt{STDOPT}\nscodeidx{Test!Directive}{STDOPT}
directive takes as default set of options directive takes as default set of options
the last \texttt{OPT} directive(s) of the preceding configuration the last \texttt{OPT} directive(s) of the preceding configuration
level. If the preceding configuration level contains several level. If the preceding configuration level contains several
...@@ -1030,8 +1030,8 @@ options). As with \texttt{OPT}, each \texttt{STDOPT} corresponds to a different ...@@ -1030,8 +1030,8 @@ options). As with \texttt{OPT}, each \texttt{STDOPT} corresponds to a different
(set of) test case(s). \texttt{LOG} directives preceding an \texttt{STDOPT} (set of) test case(s). \texttt{LOG} directives preceding an \texttt{STDOPT}
are taken into account. are taken into account.
\item The syntax for directives \item The syntax for directives
\texttt{EXECNOW}\sscodeidxdef{Test}{Directive}{EXECNOW} \texttt{EXECNOW}\nscodeidx{Test!Directive}{EXECNOW}
and \texttt{EXEC}\sscodeidxdef{Test}{Directive}{EXEC} is the following. and \texttt{EXEC}\nscodeidxdef{Test!Directive}{EXEC} is the following.
\begin{code} \begin{code}
EXECNOW: [ [ LOG file | BIN file ] ... ] cmd EXECNOW: [ [ LOG file | BIN file ] ... ] cmd
\end{code} \end{code}
...@@ -1057,7 +1057,7 @@ or ...@@ -1057,7 +1057,7 @@ or
the command is put in a test configuration file: the command is put in a test configuration file:
\texttt{EXECNOW} executes the command only once for the test suite, while \texttt{EXECNOW} executes the command only once for the test suite, while
\texttt{EXEC} executes it once per test file of the test suite. \texttt{EXEC} executes it once per test file of the test suite.
\item The \texttt{MACRO}\sscodeidxdef{Test}{Directive}{MACRO} directive \item The \texttt{MACRO}\nscodeidx{Test!Directive}{MACRO} directive
has the following syntax: has the following syntax:
\begin{code} \begin{code}
MACRO: macro-name content MACRO: macro-name content
...@@ -1069,7 +1069,7 @@ or ...@@ -1069,7 +1069,7 @@ or
\texttt{STDOPT} or \texttt{EXECNOW} directive at this configuration level \texttt{STDOPT} or \texttt{EXECNOW} directive at this configuration level
or in any level below it will be replaced by \texttt{content}. Existing or in any level below it will be replaced by \texttt{content}. Existing
pre-defined macros are listed in section~\ref{sec:ptests-macros}. pre-defined macros are listed in section~\ref{sec:ptests-macros}.
\item The \texttt{FILEREG}\sscodeidxdef{Test}{Directive}{FILEREG} \item The \texttt{FILEREG}\nscodeidx{Test!Directive}{FILEREG}
directive contains a regular expression indicating which files in directive contains a regular expression indicating which files in
the directory containing the current test suite are actually part of the directory containing the current test suite are actually part of
the suite. This directive is only the suite. This directive is only
......
...@@ -30,7 +30,8 @@ ...@@ -30,7 +30,8 @@
\index{#1@\texttt{#1}!#2@\texttt{\fontsize{8}{10}\selectfont #2}|bfit}} \index{#1@\texttt{#1}!#2@\texttt{\fontsize{8}{10}\selectfont #2}|bfit}}
\newcommand{\sscodeidxdef}[3]{% \newcommand{\sscodeidxdef}[3]{%
\index{#1@\texttt{#1}!#2@\texttt{#2}!#3@\texttt{#3}|bfit}} \index{#1@\texttt{#1}!#2@\texttt{#2}!#3@\texttt{#3}|bfit}}
\newcommand{\nscodeidx}[2]{\index{#1!#2@\texttt{#2}}}
\newcommand{\nscodeidxdef}[2]{\index{#1!#2@\texttt{#2}|bfit}}
\makeatletter \makeatletter
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment