diff options
author | Karl Berry <karl@freefriends.org> | 2015-04-02 21:42:38 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2015-04-02 21:42:38 +0000 |
commit | b2dcb6358d02b5256659808c99916fe8c5975e35 (patch) | |
tree | 8de9428b72775a5afc8006b9686993f86cd10f4d /Master/texmf-dist/source/latex/l3build | |
parent | fdd807f99ca5dbba98a05ce12bd086949df0ad47 (diff) |
l3build (2apr15)
git-svn-id: svn://tug.org/texlive/trunk@36706 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/l3build')
-rw-r--r-- | Master/texmf-dist/source/latex/l3build/l3build.dtx | 28 |
1 files changed, 24 insertions, 4 deletions
diff --git a/Master/texmf-dist/source/latex/l3build/l3build.dtx b/Master/texmf-dist/source/latex/l3build/l3build.dtx index b75bd060034..9ac009cddf5 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/02/01} -\def\ExplFileVersion{5504} +\def\ExplFileDate{2015/04/02} +\def\ExplFileVersion{5564} \documentclass[full]{l3doc} \renewcommand\partname{Part} \usepackage{multicol,needspace} @@ -73,6 +73,7 @@ \def\allluavars{ \luavarset{module}{""}{The name of the module.} \luavarset{bundle}{""}{The name of the bundle in which the module belongs.} +\luavarset{ctanpkg}{bundle}{Name of the bundle on CTAN} \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} @@ -91,13 +92,15 @@ \luavarset{tdsdir} {distribdir .. "/tds"} {Generated folder where files are organised for a TDS.} \luavarset{tdsroot} {"latex"}{Root directory of the TDS structure for the bundle/module to be installed into.} \luavarseparator +\luavarset{auxfiles} {\{"*.aux", "*.toc"\}} + {Auxiliary typesetting files that should be auto-removed.} \luavarset{binaryfiles} {\{"*.pdf", "*.zip"\}} {Files to be added in binary mode to zip files.} \luavarset{checkfiles} {\{~\}}{Extra files unpacked purely for tests} \luavarset{checksuppfiles} { }{Files needed for performing regression tests.} \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{cleanfiles} {\{"*.log", "*.pdf", "*.zip"\}}{Files to delete when cleaning.} \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{makeindexfiles} {\{"*.ist"\}}{MakeIndex files to be included in a TDS-style zip} @@ -259,6 +262,13 @@ % 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 +% \texttt{\meta{texmf}/tex/latex/base}. This can be handled by using +% \var{ctanpkg} for the name required by CTAN to override the standard +% value. % % The |testfiles/| folder is local to each module, and its layout consists of a series of regression tests with their outputs. % \begin{Verbatim} @@ -362,7 +372,7 @@ % 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. % The build process for a |.tds.zip| file currently assumes a `standard' % structure in which all extracted files should be places inside the |tex| -% tree in a single directory, as shown above. +% tree in a single directory, as shown above. % % \pagebreak[2] % The |doc| tree is constructed from: @@ -378,6 +388,8 @@ % 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). +% +% Any auxiliary files in the working directory may interfere with the automatic typesetting process. Those listed in \var{auxfiles} are automatically removed to prevent this, and are also deleted by the |clean| operation. (This seetting is most useful when typesetting manually and automatically may use different settings, for example enabling/disabling \pkg{hyperref}.) % % 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} @@ -604,6 +616,14 @@ % \item Correction of a \LuaTeX{} error message typo (|I''m going to assume|). % \end{itemize} % +% \subsection{Generating test files with \pkg{DocStrip}} +% +% It is possible to pack tests inside source files. Tests generated during the +% unpacking process will be available to the \texttt{check} and \texttt{save} +% commands as if they were stored in the \texttt{testfiledir}. Any explicit +% test files inside \texttt{testfiledir} take priority over generated ones +% with the same names. +% % \section{Writing test files} % \label{sec:writing-tests} % |