diff options
author | Karl Berry <karl@freefriends.org> | 2014-07-20 22:15:02 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-07-20 22:15:02 +0000 |
commit | 97666739085cbc6593468e7f5a2cc04f2eaf0de2 (patch) | |
tree | cb376a0a93994b3b2f420e124d678f7efc1d0a68 /Master/texmf-dist/source/latex/l3build/l3build.dtx | |
parent | 6c2678db440b5260ec13602bde6efebdd00f8549 (diff) |
l3build
git-svn-id: svn://tug.org/texlive/trunk@34672 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/l3build/l3build.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/l3build/l3build.dtx | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/Master/texmf-dist/source/latex/l3build/l3build.dtx b/Master/texmf-dist/source/latex/l3build/l3build.dtx index 54b031c021f..c24304f0f68 100644 --- a/Master/texmf-dist/source/latex/l3build/l3build.dtx +++ b/Master/texmf-dist/source/latex/l3build/l3build.dtx @@ -39,8 +39,8 @@ \RequirePackage{expl3} \def\ExplFileName{l3build} \def\ExplFileDescription{L3 Regression test suite} -\def\ExplFileDate{2014/06/15} -\def\ExplFileVersion{5141} +\def\ExplFileDate{2014/07/19} +\def\ExplFileVersion{5240} \documentclass[full]{l3doc} \renewcommand\partname{Part} \usepackage{multicol,needspace} @@ -74,6 +74,9 @@ \luavarset{module}{""}{The name of the module.} \luavarset{bundle}{""}{The name of the bundle in which the module belongs.} \luavarseparator +\luavarset{modules}{\{~\}}{The list of all modules in a bundle (when not auto-detecting)} +\luavarset{exclmodules}{\{~\}}{Directories to be excluded from automatic module detection} +\luavarseparator \luavarset{maindir} {"."}{The top level directory for this module or bundle.} \luavarset{supportdir} {maindir .. "/support"} {Where copies of files to support check/doc compilation are stored.} \luavarset{testfiledir} {maindir .. "/testfiles"} {Where the tests are.} @@ -95,7 +98,7 @@ \luavarset{cmdchkfiles} {\{~\}}{Files need to perform command checking (\cls{l3doc}-based documentation only).} \luavarset{demofiles} {\{~\}}{Files which show how to use a module.} \luavarset{cleanfiles} {\{"*.pdf", "*.zip"\}}{Files to delete when cleaning.} -\luavarset{excludefiles} {\{"*\string~"\}} {Files to ignore entirely (default for Emacs auto-save files).} +\luavarset{excludefiles} {\{"*\string~"\}} {Files to ignore entirely (default for Emacs backup files).} \luavarset{installfiles} {\{"*.sty"\}} {Files to install to the \TeX{} tree and similar tasks.} \luavarset{sourcefiles} {\{"*.dtx", "*.ins"\}}{Files to copy for unpacking.} \luavarset{txtfiles} {\{"*.markdown"\}} {Files which should have the extension removed when sent to CTAN.} @@ -112,8 +115,9 @@ \luavarset{typesetdeps} {\{~\}} {\dots for typesetting docs.} \luavarset{unpackdeps} {\{~\}} {\dots for unpacking.} \luavarseparator -\luavarset{chkengines} {\{"pdftex", "xetex", "luatex"\}} {Engines to check with \texttt{checklvt} by default.} -\luavarset{stdengine} {"pdtex"} {Engine to generate \texttt{.tlg} file from.} +\luavarset{checkengines}{\{"pdftex", "xetex", "luatex"\}} {Engines to check with \texttt{checklvt} by default.} +\luavarset{stdengine} {"pdtex"} {Engine to generate \texttt{.tlg} file from.} +\luavarset{checkformat} {"latex"} {Format to use for tests.} \luavarseparator \luavarset{typesetexe} {"pdflatex"} {Executable for compiling \texttt{doc(s)}.} \luavarset{unpackexe} {"tex"} {Executable for running \texttt{unpack}.} @@ -297,7 +301,9 @@ % This range of possibilities allow sensible defaults but significant flexibility for defining your own test setups. % % 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 |chkengines| and |stdengine| variable respectively). +% 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 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{plain} will run tests using \emph{e.g.}~\texttt{pdftex}. +% (Currently, this should be one of \texttt{latex} or \texttt{plain}.) % To perform the check, the engine typesets each test \var{checkruns} times. % More detail on this in the documentation on |savetlg|. % Options passed to the binary are defined in the variable \var{checkopts}. @@ -308,7 +314,7 @@ % % \begin{buildcmd}{checklvt \meta{name} [\meta{engine}]} % Checks only the test \texttt{\meta{name}.lvt} with optionally specified \meta{engine} (one of |pdftex|, |xetex|, or |luatex|). -% If an \meta{engine} is not specified, all three engines are checked (or those defined by the |chkengines| variable if changed from the default). +% If an \meta{engine} is not specified, all three engines are checked (or those defined by the |checkengines| variable if changed from the default). % \end{buildcmd} % % \begin{buildcmd}{cmdcheck} @@ -347,7 +353,7 @@ % abc.sty % \end{Verbatim} % The files copied into the archive are controlled by a number of variables. -% The `root' of the TDS structure is defined by \var{tdsroot}, which is \luavar{tdsroot} by default. Plain users would redefine this to |"generic"|, for example. +% The `root' of the TDS structure is defined by \var{tdsroot}, which is \luavar{tdsroot} by default. Plain users would redefine this to |"plain"| (or perhaps |"generic"|), for example. % % \pagebreak[2] % The |doc| tree is constructed from: @@ -611,7 +617,7 @@ % The |\END| command signals the end of the test (but read on). % Some additional diagnostic information is printed at this time to debug if the test did not complete `properly' in terms of mismatched brace groups or \cs{if}\dots\cs{fi} groups. % -% In a \LaTeX{} document, |\end{document}| will implicity call |\END| at the very end of the compilation process. +% In a \LaTeX{} document, |\end{document}| will implicitly call |\END| at the very end of the compilation process. % If |\END| is used directly (replacing |\end{document}| in the test), the compilation will halt almost immediately, and various tasks that |\end{document}| usually performs will not occur (such as potentially writing to the various |.toc| files, and so on). This can be an advantage if there is additional material printed to the log file in this stage that you wish to ignore, but it is a disadvantage if the test relies on various auxiliary data for a subsequent typesetting run. % (See the \var{checkruns} variable for how these tests would be test up.) % @@ -640,7 +646,8 @@ % \end{itemize} % An example of some of these commands is shown following. % \begin{Verbatim} -% \begin{TEST}{bool_set,~lazy~evaluation} +% \TEST{bool_set,~lazy~evaluation} +% { % \bool_set:Nn \l_tmpa_bool % { % \int_compare_p:nNn 1=1 @@ -653,7 +660,7 @@ % && \int_compare_p:nNn 2=2 % } % \bool_if:NTF \l_tmpa_bool \TRUE \FALSE -% \end{TEST} +% } % \end{Verbatim} % This test will produce the following in the output. % \begin{Verbatim} |