[latex3-commits] [latex3/l3build] main: Improve docs on stdengine (e47ee30)

[github at latex-project.org]

Repository : https://github.com/latex3/l3build
On branch  : main
Link       : https://github.com/latex3/l3build/commit/e47ee30b8f67c6250f4a98437151585e3a550808

>---------------------------------------------------------------

commit e47ee30b8f67c6250f4a98437151585e3a550808
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Mon Jul 17 10:12:44 2023 +0100

    Improve docs on stdengine


>---------------------------------------------------------------

e47ee30b8f67c6250f4a98437151585e3a550808
 l3build.dtx | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/l3build.dtx b/l3build.dtx
index 9a99811..303b334 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -428,6 +428,10 @@
 %
 % Checking can be performed with any or all of the `engines' \texttt{pdftex}, \texttt{xetex}, and \texttt{luatex}.
 % By default, each test is executed with all three, being compared against the \texttt{.tlg} file produced from the \var{pdftex} engine (these defaults are controlled by the |checkengines| and |stdengine| variable, respectively).
+% The standard engine to use is typically chosen automatically as the first entry in
+% \var{checkengines}, but may be set manually using \var{stdengine}. Where multiple
+% configurations are used and need adjustment to the standard engine, this does
+% need to be given explicitly using \var{stdengine}.
 % The format used for tests can be altered by setting \var{checkformat}: the default setting \texttt{latex} means that tests are run using \emph{e.g.}~\texttt{pdflatex}, whereas setting to \texttt{tex} will run tests using \emph{e.g.}~\texttt{pdftex}.
 % (Currently, this should be one of \texttt{latex} or \texttt{tex}.)
 % To perform the check, the engine typesets each test up to \var{checkruns} times.