[latex3-commits] [l3svn] 01/07: l3build: Extend documentation [ci skip]

[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.

commit 21343a30a8725db572900a95ecc776fbf361858f
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Sun May 22 19:52:36 2016 +0100

    l3build: Extend documentation [ci skip]
    
    Mainly covering "-p" option for "save"/"check" (may yet change
    name), but also some other missed bits and pieces.
---
 l3build/l3build.dtx |   28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/l3build/l3build.dtx b/l3build/l3build.dtx
index 5da63f0..eaeea52 100644
--- a/l3build/l3build.dtx
+++ b/l3build/l3build.dtx
@@ -114,11 +114,13 @@
 \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{lvtext} {".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.}
@@ -312,17 +314,24 @@
 % \item doc
 % \item install
 % \item save \meta{name(s)}
+% \item setversion
 % \end{itemize}
 % These commands are described below.
 %
 % As well as these commands, the system recognises the options
 % \begin{itemize}
+% \item \texttt{--date} (\texttt{-d}) Date to use when setting version 
+%   data
 % \item \texttt{--engine} (\texttt{-e}) Sets the engine to use for
 %   testing
 % \item \texttt{--halt-on-error} (\texttt{-H}) Specifies that checks
 %   should stop as soon as possible, rather than running all requested
 %   tests
+% \item \texttt{--pdf} (\texttt{-p}) Test PDF file against a reference
+%   version as well as log comparison
 % \item \texttt{--quiet} (\texttt{-q}) Suppresses output from unpacking
+% \item \texttt{--version} (\texttt{-v}) Version string to use when setting
+%   version data
 % \end{itemize}
 %
 % \begin{buildcmd}{check}
@@ -369,6 +378,16 @@
 % testing to a single engine.
 % \end{buildcmd}
 %
+% \begin{buildcmd}{check -p}
+% In addition to the log-based checking carried out by the standard
+% |check| target, running with the |-p| option will also carry out a binary
+% comparison of the PDF files produced by typesetting against those
+% saved in \var{testfiledir}.
+% 
+% This functionality requires \TeX{} Live 2016 or later as it needs support
+% from the engines not available in earlier releases.
+% \end{buildcmd}
+%
 % \begin{buildcmd}{cmdcheck}
 % For \cls{l3doc}-based sources, allows checking that the commands defined in the code part  (by \var{cmdchkfiles}) are documented in the description part.
 % This is performed by passing the |check| option to the \cls{l3doc} class, typesetting the file(s) to check with engine \var{stdengine} with options \var{cmdchkopts}, and checking the resultant |.cmds| file(s).
@@ -463,6 +482,15 @@
 % A normalisation process is performed when checking to avoid common differences such as register allocation; full details are listed in section~\ref{sec:norm}.
 % \end{buildcmd}
 %
+% \begin{buildcmd}{save -p \meta{name(s)}}
+% This version of |save| will store the PDF files produced from
+% \texttt{\meta{name(s)}.lvt} in addition to the |.tlg| file, and thus allows
+% binary comparison of the result of typesetting.
+%
+% This functionality requires \TeX{} Live 2016 or later as it needs support
+% from the engines not available in earlier releases.
+% \end{buildcmd}
+%
 % \begin{buildcmd}{setversion}
 % Modifies the content of files specified by |versionfiles| to allow
 % automatic updating of the file date and version. The latter are

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