diff options
author | Karl Berry <karl@freefriends.org> | 2017-12-07 23:16:26 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2017-12-07 23:16:26 +0000 |
commit | 1fed4553e07e0372e12d6a1ac32f29b3c7a2a538 (patch) | |
tree | 1cbfce535eaa4ad401f88e70d29998b9ffe4d2ec /Master/texmf-dist/source/latex/l3build | |
parent | a1e3748b2a855f1a0c875df7f9585e1a01c44d9a (diff) |
l3experimental+l3build (7dec17)
git-svn-id: svn://tug.org/texlive/trunk@46013 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 | 136 |
1 files changed, 71 insertions, 65 deletions
diff --git a/Master/texmf-dist/source/latex/l3build/l3build.dtx b/Master/texmf-dist/source/latex/l3build/l3build.dtx index d894295b15c..d5adf1a913f 100644 --- a/Master/texmf-dist/source/latex/l3build/l3build.dtx +++ b/Master/texmf-dist/source/latex/l3build/l3build.dtx @@ -50,71 +50,71 @@ \newcommand\luavarseparator{} \makeatother \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} +\luavarset{module}{""}{The name of the module} +\luavarset{bundle}{""}{The name of the bundle in which the module belongs (where relevant)} +\luavarset{ctanpkg}{module/bundle}{Name of the CTAN package matching this module} \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} +\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.} -\luavarset{testsuppdir} {testfiledir .. "/support"} {Where support files for the tests are.} +\luavarset{maindir} {"."} {Top level directory for the module/bundle} +\luavarset{docfiledir} {maindir} {Directory containing documentation files} +\luavarset{supportdir} {maindir .. "/support"} {Directory containing general support files} +\luavarset{testfiledir}{maindir .. "/testfiles"} {Directory containing test files} +\luavarset{testsuppdir}{testfiledir .. "/support"}{Directory containing test-specific support files} \luavarseparator -\luavarset{localdir} {maindir .. "/build/local"} {Generated folder where support files are placed to allow \enquote{sandboxed} \TeX{} runs.} -\luavarset{testdir} {maindir .. "/build/test"} {Generated folder where tests are run.} -\luavarset{typesetdir} {maindir .. "/build/doc"} {Generated folder where typesetting is run.} -\luavarset{unpackdir} {maindir .. "/build/unpack"} {Generated folder where unpacking occurs.} -\luavarset{distribdir} {maindir .. "/build/distrib"}{Generated folder where the archive is created.} -\luavarset{ctandir} {distribdir .. "/ctan"} {Generated folder where files are organised for CTAN.} -\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.} +\luavarset{distribdir}{maindir .. "/build/distrib"}{Directory for generating distribution structure} +\luavarset{localdir} {maindir .. "/build/local"} {Directory for extracted files in \enquote{sandboxed} \TeX{} runs} +\luavarset{testdir} {maindir .. "/build/test"} {Directory for running tests} +\luavarset{typesetdir}{maindir .. "/build/doc"} {Directory for building documentation} +\luavarset{unpackdir} {maindir .. "/build/unpack"} {Directory for unpacking sources} \luavarseparator -\luavarset{bibfiles} {\{"*.bib"\}}{\BibTeX{} database files.} -\luavarset{binaryfiles} {\{"*.pdf", "*.zip"\}} - {Files to be added in binary mode to zip files.} -\luavarset{bstfiles} {\{"*.bst"\}}{\BibTeX{} style files.} +\luavarset{ctandir}{distribdir .. "/ctan"}{Directory for organising files for CTAN} +\luavarset{tdsdir} {distribdir .. "/tds"} {Directory for organised files into TDS structure} +\luavarset{tdsroot}{"latex"}{Root directory of the TDS structure for the bundle/module to be installed into} +\luavarseparator +\luavarset{bibfiles} {\{"*.bib"\}}{\BibTeX{} database files} +\luavarset{binaryfiles} {\{"*.pdf", "*.zip"\}}{Files to be added in binary mode to zip files} +\luavarset{bstfiles} {\{"*.bst"\}}{\BibTeX{} style 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{cleanfiles} {\{"*.log", "*.pdf", "*.zip"\}}{Files to delete when cleaning.} -\luavarset{demofiles} {\{~\}}{Files which show how to use a module.} -\luavarset{docfiles} {\{~\}}{Files which are part of the documentation but should not be typeset.} -\luavarset{excludefiles} {\{"*\string~"\}} {Files to ignore entirely (default for Emacs backup files).} -\luavarset{installfiles} {\{"*.sty","*.cls"\}} {Files to install to the \TeX{} tree and similar tasks.} +\luavarset{checksuppfiles} { }{Files needed for performing regression tests} +\luavarset{cmdchkfiles} {\{\}}{Files need to perform command checking (\cls{l3doc}-based documentation only)} +\luavarset{cleanfiles} {\{"*.log", "*.pdf", "*.zip"\}}{Files to delete when cleaning} +\luavarset{demofiles} {\{\}}{Files which show how to use a module} +\luavarset{docfiles} {\{\}}{Files which are part of the documentation but should not be typeset} +\luavarset{excludefiles} {\{"*\string~"\}}{Files to ignore entirely (default for Emacs backup files)} +\luavarset{installfiles} {\{"*.sty","*.cls"\}}{Files to install to the \TeX{} tree and similar task} \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{typesetdemofiles} {\{~\}} {Files to typeset before the documentation (as demos), but where the PDF results are not included in the release.} -\luavarset{typesetfiles} {\{"*.dtx"\}} {Files to typeset for documentation.} -\luavarset{docfiledir} {maindir}{Where to look for the |typesetfiles| and |typesetsourcefiles|.} -\luavarset{typesetsuppfiles} {\{~\}} {Files needed to support typesetting when \enquote{sandboxed}.} -\luavarset{typesetsourcefiles}{\{~\}} {Files to copy to unpacking when typesetting.} -\luavarset{unpackfiles} {\{"*.ins"\}} {Files to run to perform unpacking.} -\luavarset{unpacksuppfiles} {\{~\}} {Files needed to support unpacking when \enquote{sandboxed}.} -\luavarset{versionfiles} {\{"*.dtx"\}} {Files for automatic version editing.} +\luavarset{sourcefiles} {\{"*.dtx", "*.ins"\}}{Files to copy for unpacking} +\luavarset{textfiles} {\{"*.md", "*.txt"\}}{Plain text files to send to CTAN as-is} +\luavarset{typesetdemofiles} {\{\}}{Files to typeset before the documentation for inclusion in main documentation files} +\luavarset{typesetfiles} {\{"*.dtx"\}}{Files to typeset for documentation} +\luavarset{typesetsuppfiles} {\{\}}{Files needed to support typesetting when \enquote{sandboxed}} +\luavarset{typesetsourcefiles}{\{\}}{Files to copy to unpacking when typesetting.} +\luavarset{unpackfiles} {\{"*.ins"\}}{Files to run to perform unpacking.} +\luavarset{unpacksuppfiles} {\{\}}{Files needed to support unpacking when \enquote{sandboxed}} +\luavarset{versionfiles} {\{"*.dtx"\}}{Files for automatic version editing} \luavarseparator -\luavarset{bakext} {".bak"} {Extension of backup files.} -\luavarset{dviext} {".dvi"} {Extension of DVI files.} -\luavarset{lvtext} {".lvt"} {Extension of test files.} -\luavarset{tlgext} {".tlg"} {Extension of test file output.} -\luavarset{lveext} {".lve"} {Extension of auto-generating test file output.} -\luavarset{logext} {".log"} {Extension of checking output, before processing it into a \texttt{.tlg}.} -\luavarset{pdfext} {".pdf"} {Extension of PDF file for checking and saving.} -\luavarset{psext} {".ps"} {Extension of PostScript files.} +\luavarset{bakext}{".bak"}{Extension of backup files} +\luavarset{dviext}{".dvi"}{Extension of DVI files} +\luavarset{lvtext}{".lvt"}{Extension of test files} +\luavarset{tlgext}{".tlg"}{Extension of test file output} +\luavarset{lveext}{".lve"}{Extension of auto-generating test file output} +\luavarset{logext}{".log"}{Extension of checking output, before processing it into a \texttt{.tlg}} +\luavarset{pdfext}{".pdf"}{Extension of PDF file for checking and saving} +\luavarset{psext} {".ps"} {Extension of PostScript files} \luavarseparator -\luavarset{checkdeps} {\{~\}} {List of build unpack dependencies for checking.} -\luavarset{typesetdeps} {\{~\}} {\dots for typesetting docs.} -\luavarset{unpackdeps} {\{~\}} {\dots for unpacking.} +\luavarset{checkdeps} {\{\}}{List of dependencies for running checks} +\luavarset{typesetdeps}{\{\}}{List of dependencies for typesetting docs} +\luavarset{unpackdeps} {\{\}}{List of dependencies for unpacking} \luavarseparator -\luavarset{checkengines}{\{"pdftex", "xetex", "luatex"\}} {Engines to check with \texttt{check} by default.} -\luavarset{stdengine} {"pdftex"} {Engine to generate \texttt{.tlg} file from.} -\luavarset{checkformat} {"latex"} {Format to use for tests.} +\luavarset{checkengines}{\{"pdftex", "xetex", "luatex"\}}{Engines to check with \texttt{check} by default} +\luavarset{stdengine} {"pdftex"}{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}.} -\luavarset{zipexe} {"zip"} {Executable for creating archive with \texttt{ctan}.} +\luavarset{typesetexe}{"pdflatex"}{Executable for compiling \texttt{doc(s)}} +\luavarset{unpackexe} {"tex"} {Executable for running \texttt{unpack}} +\luavarset{zipexe} {"zip"} {Executable for creating archive with \texttt{ctan}} \luavarseparator \luavarset{checkopts} {"-interaction=nonstopmode"}{Options based to engine when running checks.} \luavarset{cmdchkopts} {"-interaction=batchmode"} {Options based to engine when running command checks.} @@ -122,9 +122,9 @@ \luavarset{unpackopts} {""} {Options based to engine when unpacking.} \luavarset{zipopts} {"-v -r -X"} {Options based to zip program.} \luavarseparator -\luavarset{checksearch} {true} {Look in \texttt{tds} dirs for checking?} -\luavarset{typesetsearch}{true} {Look in \texttt{tds} dirs for typesetting docs?} -\luavarset{unpacksearch} {true} {Look in \texttt{tds} dirs for unpacking?} +\luavarset{checksearch} {true}{Switch to search the system \texttt{texmf} for during checking} +\luavarset{typesetsearch}{true}{Switch to search the system \texttt{texmf} for during typesetting} +\luavarset{unpacksearch} {true}{Switch to search the system \texttt{texmf} for during unpacking} \luavarseparator \luavarset{glossarystyle}{"gglo.ist"}{MakeIndex style file for glossary/changes creation} \luavarset{indexstyle} {"gind.ist"}{MakeIndex style for index creation} @@ -141,14 +141,15 @@ \luavarset{forcedocepoch} {"false"} {Force epoch when typesetting} \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{epoch} {1463734800} {Epoch (Unix date) to set for test runs.} -\luavarset{maxprintline}{79} {Length of line to use in log files.} -\luavarset{packtdszip} {false} {Build a TDS-style zip file for CTAN?} -\luavarset{scriptname} {"build.lua"} {Name of script used in dependencies.} +\luavarset{checkruns} {1} {Number of runs to complete for a test before comparing the log} +\luavarset{epoch} {1463734800} {Epoch (Unix date) to set for test runs} +\luavarset{maxprintline}{79} {Length of line to use in log files} +\luavarset{packtdszip} {false} {Switch to build a TDS-style zip file for CTAN} +\luavarset{scriptname} {"build.lua"} {Name of script used in dependencies} \luavarset{typesetcmds} {""} {Instructions to be passed to \TeX{} when doing typesetting.} +\luavarset{typsetcycles}{3} {Number of cycles of typesetting to carry out.} \luavarset{versionform} {""} {Nature of version strings for auto-replacement.} -\luavarset{recordstatus} {false} {Include error level(s) from test run(s) in TLG files?} +\luavarset{recordstatus}{false} {Switch to include error level from test runs in \texttt{.tlg} files} } \allluavars \newcommand\luavartypeset{% @@ -208,7 +209,7 @@ % }^^A % } % -% \date{Released 2017/11/25} +% \date{Released 2017/12/06} % % \maketitle % \tableofcontents @@ -708,6 +709,11 @@ % 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 Conversion of register numbers in assignment lines +% \texttt{\cs{\meta{register}}=\cs{\meta{type}}\meta{number}} to +% \texttt{\cs{\meta{type}}\meta{...}} +% \item Conversion of box numbers in |\show| lines +% \texttt{>~\cs{box}\meta{number}=} to \texttt{>~\cs{box}...=} % \end{itemize} % % \LuaTeX{} makes several additional changes to the log file. As normalising |