From 94643712598fbf6201eed1a9f876a2fd6ea19395 Mon Sep 17 00:00:00 2001
From: Andre Maroneze <andre.oliveiramaroneze@cea.fr>
Date: Wed, 29 Apr 2020 09:48:25 +0200
Subject: [PATCH] [Doc/Devman] Update ptests section in developer manual
---
doc/developer/advance.tex | 18 ++++--------------
doc/developer/architecture.tex | 7 -------
ptests/ptests.ml | 2 +-
3 files changed, 5 insertions(+), 22 deletions(-)
diff --git a/doc/developer/advance.tex b/doc/developer/advance.tex
index 3aa40e5f9d3..b776b213076 100644
--- a/doc/developer/advance.tex
+++ b/doc/developer/advance.tex
@@ -709,19 +709,6 @@ There is exactly one directive by line. The different directives (\emph{i.e.}
possibilities for \texttt{CONFIG\_OPTION}) are detailed in
Section~\ref{ptests:directives}.
-\begin{important}
-Note that some specific configurations require dynamic linking, which
-is not available on all platforms for native code. {\tt ptests} takes
-care of reverting to bytecode when it detects that the {\tt OPT},
-{\tt EXECNOW}, or \texttt{EXEC} options of a test require dynamic linking. This
-occurs currently in the following cases:
-\begin{itemize}
-\item {\tt OPT} contains the option {\tt -load-script}
-\item {\tt OPT} contains the option {\tt -load-module}
-\item {\tt EXECNOW} and \texttt{EXEC} use {\tt make} to create a {\tt .cmxs}
-\end{itemize}
-\end{important}
-
\begin{important}
\textbf{Concurrency issues:}
tests using compiled modules ({\tt -load-script} or {\tt -load-module}) may
@@ -740,6 +727,7 @@ occurs currently in the following cases:
In addition, if the same script {\tt tests/suite/script.ml}
is shared by several test files, the {\tt EXECNOW} directive should be put
into {\tt tests/suite/test\_config}.
+ Check the {\tt MODULE} directive for a common solution to this issue.
\end{important}
@@ -832,9 +820,11 @@ Figure~\ref{fig:ptests-options} details the options of \ptests.
& \texttt{-byte} & Use bytecode toplevel & no \\
& \texttt{-opt} & Use native toplevel & yes \\
& \texttt{-gui} & Use GUI instead of console-based toplevel & no \\
-\hline \multirow{4}{16mm}{\centering{Behavior}}
+\hline \multirow{5}{16mm}{\centering{Behavior}}
& \texttt{-run} & Delete current results; run tests and examine results & yes
\\
+& \texttt{-dry-run} & Print commands, but do not execute them & no
+\\
& \texttt{-examine} & Only examine current results; do not run tests & no \\
& \texttt{-show} & Run tests and show results, but do not examine
them; implies \texttt{-byte} &
diff --git a/doc/developer/architecture.tex b/doc/developer/architecture.tex
index 0d01872a0df..6d9f6b197d1 100644
--- a/doc/developer/architecture.tex
+++ b/doc/developer/architecture.tex
@@ -203,13 +203,6 @@ only possible one to define mutually dependent plug-ins while the third one
(through module \texttt{Db}) is now fully deprecated even if most of the older
\framac plug-ins are still defined this way.
-Plug-ins are usually dynamically linked when \framac is booting, even if some
-older \framac plug-ins are still statically linked. However it is still possible
-to statically link a dynamic plug-in if wanted or required. In particular,
-\ocaml does not support dynamic linking on some hardware
-architecture~\cite{caml}: in this case, you have to statically link all
-plug-ins.
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Libraries}\label{archi:libraries}
diff --git a/ptests/ptests.ml b/ptests/ptests.ml
index 8343b8cc01a..27af94c1569 100644
--- a/ptests/ptests.ml
+++ b/ptests/ptests.ml
@@ -338,7 +338,7 @@ let rec argspec =
"-xunit", Arg.Set xunit,
" Create a xUnit file named xunit.xml collecting results";
"-error-code", Arg.Set do_error_code,
- " Exit with error code 1 if tests failed (useful for scripts";
+ " Exit with error code 1 if tests failed (useful for scripts)";
]
and help_msg () = Arg.usage (Arg.align argspec) umsg;;
--
GitLab