diff options
author | Karl Berry <karl@freefriends.org> | 2015-09-14 21:54:24 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-09-14 21:54:24 +0000 |
commit | ce8261713a3c6542d6509919d8dc0f75329432ad (patch) | |
tree | d0bfeba8c7f385fde614fd7f97497ede040a2bc5 /Master/texmf-dist/source/latex | |
parent | 06ca0b68a1199a658979f91eec6aec65bca22075 (diff) |
l3build (14sep15)
git-svn-id: svn://tug.org/texlive/trunk@38376 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex')
-rw-r--r-- | Master/texmf-dist/source/latex/l3build/l3build.dtx | 52 |
1 files changed, 36 insertions, 16 deletions
diff --git a/Master/texmf-dist/source/latex/l3build/l3build.dtx b/Master/texmf-dist/source/latex/l3build/l3build.dtx index 8ab332e83dc..f94bcdec5ba 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{2015/09/05} -\def\ExplFileVersion{5925} +\def\ExplFileDate{2015/09/14} +\def\ExplFileVersion{6007} \documentclass[full]{l3doc} \renewcommand\partname{Part} \usepackage{multicol,needspace} @@ -106,7 +106,7 @@ \luavarset{installfiles} {\{"*.sty"\}} {Files to install to the \TeX{} tree and similar tasks.} \luavarset{makeindexfiles} {\{"*.ist"\}}{MakeIndex files to be included in a TDS-style zip} \luavarset{sourcefiles} {\{"*.dtx", "*.ins"\}}{Files to copy for unpacking.} -\luavarset{textfiles} {\{"*.md", "*.txt"\}}{Plain text files to send to CTAN as-is.} +\luavarset{textfiles} {\{"*.md", "*.txt"\}}{Plain text files to send to CTAN as-is.} \luavarset{typesetfiles} {\{"*.dtx"\}} {Files to typeset for documentation.} \luavarset{typesetsuppfiles}{\{~\}} {Files needed to support typesetting when \enquote{sandboxed}.} \luavarset{unpackfiles} {\{"*.ins"\}} {Files to run to perform unpacking.} @@ -150,6 +150,7 @@ \luavarset{makeindexexe} {"makeindex"}{MakeIndex executable} \luavarset{makeindexopts}{""} {MakeIndex options} \luavarseparator +\luavarset{asciiengines}{\{"pdftex"\}}{Engines which should log as sure ASCII} \luavarset{checkruns} {1} {How many times to run a check file before comparing the log.} \luavarset{packtdszip} {false} {Build a TDS-style zip file for CTAN?} \luavarset{scriptname} {"build.lua"} {Name of script used in dependencies.} @@ -271,7 +272,7 @@ % yyy.ins zoo.ins % \end{Verbatim} % All modules within a bundle must use the same build script name. -% +% % In a small number of cases, the name used by CTAN for a module or bundle is % different from that used in the installation tree. For example, the \LaTeXe{} % kernel is called \pkg{latex-base} by CTAN but is located inside @@ -307,7 +308,7 @@ % \item save \meta{name(s)} % \end{itemize} % These commands are described below. -% +% % As well as these commands, the system recognises the options % \begin{itemize} % \item \texttt{--engine} (\texttt{-e}) Sets the engine to use for @@ -324,6 +325,15 @@ % If changes to the package or the typesetting environment have affected the results, the check for that file fails. % A |diff| of the expected to actual output should then be inspected to determine the cause of the error; it is located in the \var{testdir} directory (default \luavar{testdir}). % +% On Windows, the |diff| program is not available and so |fc| is used instead +% (generating an |.fc| file). Setting the environmental variables |diffexe| +% and |diffext| can be used to adjust the choice of comparison made: the standard +% values are +% \begin{itemize} +% \item[Windows] |diffext = fc|, |diffexe = fc /n| +% \item[*nix] |diffext = diff|, |diffexe = diff -c --strip-trailing-cr| +% \end{itemize} +% % The following files are moved into the \enquote{sandbox} for the |check| process: % \begin{itemize} % \item all \var{installfiles} after unpacking; @@ -341,7 +351,7 @@ % More detail on this in the documentation on |save|. % Options passed to the binary are defined in the variable \var{checkopts}. % -% By default, |texmf| trees are searched for input files when checking. This can be disabled by setting \var{checksearch} to |false|: isolation provides confidence that the tests cannot accidentally be running with incorrect files installed in the main distribution or |hometexmf|. +% By default, |texmf| trees are searched for input files when checking. This can be disabled by setting \var{checksearch} to |false|: isolation provides confidence that the tests cannot accidentally be running with incorrect files installed in the main distribution or |hometexmf|. % \end{buildcmd} % % @@ -401,7 +411,7 @@ % \begin{itemize} % \item all files matched by \var{demofiles}, % \item all files matched by \var{docfiles}, -% \item all files matched by \var{typesetfiles} with their extension replaced with |.pdf|, +% \item all files matched by \var{typesetfiles} with their extension replaced with |.pdf|, % \item all files matched by \var{textfiles}, % \item all files matched by \var{bibfiles}. % \end{itemize} @@ -411,7 +421,7 @@ % Files that should always be excluded from the archive are matched against the \var{excludefiles} variable; by default this is \luavar{excludefiles}, which match Emacs' autosave files. % % Binary files should be specified with the \var{binaryfiles} variable (default \luavar{binaryfiles}); these are added to the zip archive without normalising line endings (text files are automatically converted to Unix-style line endings). -% +% % To create the archive, by default the binary \var{zipexe} is used (\luavar{zipexe}) with options \var{zipopts} (|-v -r -X|). The intermediate build directories \var{ctandir} and \var{tdsdir} are used to construct the archive. % \end{buildcmd} % @@ -623,14 +633,14 @@ % years due to a \TeX{} bug). % \item Conversion of \texttt{on line \meta{number}} to \texttt{on line ...} % to allow flexibility in changes to test files. -% \item +% \item % \end{itemize} -% +% % \LuaTeX{} makes several additional changes to the log file. As normalising % these may not be desirable in all cases, they are handled separately. % When creating \LuaTeX{}-specific test files (either with \LuaTeX{} as -% the standard engine or saving a \LuaTeX{}-specific |.tlg| file) no futher -% normalisation is undertaken. On the other hand, for cross-engine comparision +% the standard engine or saving a \LuaTeX{}-specific |.tlg| file) no further +% normalisation is undertaken. On the other hand, for cross-engine comparison % the following normalisation is applied: % \begin{itemize} % \item Removal of additional (unused) |\discretionary| points. @@ -645,6 +655,16 @@ % \item Conversion of low chars ($1$ to $31$) to |^^| notation. % \end{itemize} % +% When making comparisons between 8-bit and Unicode engines it is useful to +% format the top half of the 8-bit range such that it appears in the log as +% |^^|\texttt{\meta{char}} (the exact nature of the 8-bit output is otherwise +% dependent on the active code page). This may be controlled using the +% |asciiengines| option. Any engines named here will use a |.tcx| file to +% produce only ASCII chars in the log output, whilst for other engines +% normalisation is carried out from UTF-8 to ASCII. If the option is set to +% an empty table the latter process is skipped: suitable for cases where only +% Unicode engines are in use. +% % \section{Writing test files} % \label{sec:writing-tests} % @@ -678,7 +698,7 @@ % (See the \var{checkruns} variable for how these tests would be test up.) % % \subsection{Commands to help write tests} -% +% % A simple command \cs{CHECKCOMMAND}\cs{\meta{macro}} is provided to check whether a particular \cs{\meta{macro}} is defined, undefined, or equivalent to \cs{relax}. % This is useful to flag either that internal macros are remaining local to their definitions, or that defined commands definitely are defined, or even as a reminder that commands you intend to define in a future package need to be tested once they appear. % @@ -924,7 +944,7 @@ % For example, Figure~\ref{fig:PDF} shows a simple script which might % apply to a case where multiple \BibTeX{} runs are needed (perhaps where % citations can appear within other references). -% +% % \begin{figure}[!b] % \begin{lstlisting}[frame=single,language={[5.2]Lua},gobble = 6] % #!/usr/bin/env texlua @@ -944,7 +964,7 @@ % bibtex (name) + % tex (file) + % tex (file) -% ) +% ) % end % return errorlevel % end @@ -994,7 +1014,7 @@ \showboxdepth=\maxdimen % \end{macrocode} % -% The |\showoutput| command of \LaTeX{} calls |\loggingoutput| which in +% The |\showoutput| command of \LaTeX{} calls |\loggingoutput| which in % turn calls |\errorstopmode| but we want to continue running without % any stops. % \begin{macrocode} |