Skip to content

Commit 0e64fef

Browse files
muzimuzhijosephwright
authored andcommitted
Update doc for -e, --engine
It accepts one or more comma-separated engines, rather than just a single one.
1 parent 49bfcb2 commit 0e64fef

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

l3build.dtx

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@
378378
% \item |--dry-run| Runs the \texttt{install} target but does not copy
379379
% any files: simply lists those that would be installed
380380
% \item |--email| Sets the email address for CTAN upload
381-
% \item |--engine| (|-e|) Sets the engine to use for testing
381+
% \item |--engine| (|-e|) Sets the engine(s) to use for testing
382382
% \item |--epoch| Sets the epoch for typesetting and testing
383383
% \item |--file| (|-F|) Takes the upload announcement from the given file
384384
% \item |--first| Name of the first test to run
@@ -456,8 +456,9 @@
456456
% \begin{buildcmd}{check \meta{name(s)}}
457457
% Checks only the test \texttt{\meta{name(s)}.lvt}.
458458
% All engines specified by \var{checkengines} are tested unless the command
459-
% line option |--engine| (or |-e|) has been given to limit
460-
% testing to a single engine. Normally testing is preceded by unpacking
459+
% line option |--engine| (or |-e|) has been given a comma-separated list to
460+
% limit testing to selected |checkengines|.
461+
% Normally testing is preceded by unpacking
461462
% source files and copying the result plus any additional support to the
462463
% test directory: this may be skipped using the |--rerun| (|-r|) option.
463464
% \end{buildcmd}
@@ -572,8 +573,13 @@
572573
% This command saves the output of the test to a |.tlg| file.
573574
% This file is then used in all subsequent checks against the \texttt{\meta{name}.lvt} test.
574575
%
575-
% If the |--engine| (or |-e|) is specified (one of |pdftex|, |xetex|, or |luatex|), the saved output is stored in \texttt{\meta{name}.\meta{engine}.tlg}. This is necessary if running the test through a different engine produces a different output.
576-
% A normalization process is performed when checking to avoid common differences such as register allocation; full details are listed in Section~\vref{sec:norm}.
576+
% If the |--engine| (or |-e|) is specified (one or more comma-separated engines
577+
% in |checkengines|), the saved output is stored in
578+
% \texttt{\meta{name}.\meta{engine}.tlg} for non-standard engines.
579+
% This is necessary if running the test through a different engine produces
580+
% a different output. A normalization process is performed when checking to
581+
% avoid common differences such as register allocation; full details are listed
582+
% in Section~\vref{sec:norm}.
577583
%
578584
% If the \var{recordstatus} variable is set \var{true}, additional information
579585
% will be added to the \texttt{.tlg} to record the \enquote{exit status} of the
@@ -745,9 +751,9 @@
745751
%
746752
% To allow selection of one or more configurations, and to allow saving of
747753
% |.tlg| files in non-standard configurations, the |--config| (|-c|) option may
748-
% be used. This works in the same way as |--engine|: it takes a comma list of
749-
% configurations to apply, overriding \var{checkconfigs}. For example, in the
750-
% directory containing |config-TU.lua|, you can use
754+
% be used. This works in the same way as |--engine|: it takes a comma-separated
755+
% list of configurations to apply, overriding \var{checkconfigs}. For example,
756+
% in the directory containing |config-TU.lua|, you can use
751757
% |l3build check -cconfig-TU <name(s)>| and |l3build save -cconfig-TU <name(s)>|
752758
% to check and save tests in |testfiles-TU| directory.
753759
%

0 commit comments

Comments
 (0)