[latex3-commits] [l3svn] branch master updated: l3build: Document -t option

[noreply at latex-project.org]

This is an automated email from the git hooks/post-receive script.

joseph pushed a commit to branch master
in repository l3svn.

The following commit(s) were added to refs/heads/master by this push:
       new  fa01265   l3build: Document -t option
fa01265 is described below

commit fa0126545d9ed02e2a2408f3545539e630fed107
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Wed Jan 25 09:32:27 2017 +0000

    l3build: Document -t option
---
 l3build/l3build.dtx |   32 +++++++++++++++++++++++++++++++-
 l3build/l3build.lua |    1 +
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/l3build/l3build.dtx b/l3build/l3build.dtx
index 3073f30..26cb393 100644
--- a/l3build/l3build.dtx
+++ b/l3build/l3build.dtx
@@ -1,6 +1,6 @@
 % \iffalse
 %
-% File l3build.dtx (C) Copyright 2014-2016 The LaTeX3 Project
+% File l3build.dtx (C) Copyright 2014-2017 The LaTeX3 Project
 %
 % It may be distributed and/or modified under the conditions of the
 % LaTeX Project Public License (LPPL), either version 1.3c of this
@@ -312,6 +312,7 @@
 % \item \texttt{--quiet} (\texttt{-q}) Suppresses output from unpacking
 % \item \texttt{--release} (\texttt{-r}) Release string to use when setting
 %   version data
+% \item \texttt{--textfiledir} (\texttt{-t}) Select a specific set of tests
 % \end{itemize}
 %
 % \begin{buildcmd}{check}
@@ -590,6 +591,35 @@
 %
 % \luavartypeset
 %
+% \subsection{Multiple sets of tests}
+%
+% In most cases, a single set of tests will be appropriate for the module, with
+% a common set of configuration settings applying. However, there are situations
+% where you may need entirely independent sets of tests which have different
+% setting values, for example using different formats or where the entire set
+% will be engine-dependent. To support this, \pkg{l3build} offers the |--testfiledir|
+% (|-t|) command line option. When this is given with a directory argument it
+% overrides the \var{testfiledir} variable. Moreover, before the tests are run,
+% \pkg{l3build} will read |config.lua| within the directory (if available). This
+% should comprise a list of settings which apply to the tests in place of those in
+% the main build script.
+% 
+% For example, for the core \LaTeXe{} tests the main test files are contained
+% in a directory |testfiles| and have \var{checksearch} set \var{false}. To test
+% font loading for \XeTeX{} and \LuaTeX{} there are a second set of tests in
+% |testfiles-TU| which use the short |config.lua| file shown in
+% Figure~\ref{fig:testfiledir}. These additional tests are then run using
+% |texlua build.lua check --testfiledir=testfiles-TU|.
+% \begin{figure}
+%   \begin{lstlisting}[frame=single,language={[5.2]Lua},gobble = 6]
+%     -- Special config for these tests
+%     checksearch  = true
+%     checkengines = {"xetex","luatex"}
+%   \end{lstlisting}
+% \caption{The build script for the \pkg{xparse} module.}
+% \label{fig:testfiledir}
+% \end{figure}
+%
 % \subsection{Dependencies}
 %
 % If you have multiple packages that are developed separately but still interact in some way, it's often desirable to integrate them when performing regression tests.
diff --git a/l3build/l3build.lua b/l3build/l3build.lua
index 95c65eb..7d17eb9 100644
--- a/l3build/l3build.lua
+++ b/l3build/l3build.lua
@@ -1536,6 +1536,7 @@ function help()
   print("   --pdf|-p            Check/save PDF files")
   print("   --quiet|-q          Suppresses TeX output when unpacking")
   print("   --release|-r        Sets the release to insert into sources")
+  print("   --testfiledir|-t    Selects the specified testfile location")
   print("")
   print("See l3build.pdf for further details.")
 end

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.