[latex3-commits] [git/LaTeX3-latex3-l3build] standalone: Doc updates for #50 [ci skip] (27a8fa2)

[Joseph Wright]

Repository : https://github.com/latex3/l3build
On branch  : standalone
Link       : https://github.com/latex3/l3build/commit/27a8fa28d392a9b527a926c6785920f211abff07

>---------------------------------------------------------------

commit 27a8fa28d392a9b527a926c6785920f211abff07
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Tue Mar 6 07:32:11 2018 +0000

    Doc updates for #50 [ci skip]
    
    We will still need to work on this, for example
    once l3build can be run by name.


>---------------------------------------------------------------

27a8fa28d392a9b527a926c6785920f211abff07
 l3build.dtx |   38 +++++++-------------------------------
 1 file changed, 7 insertions(+), 31 deletions(-)

diff --git a/l3build.dtx b/l3build.dtx
index b0b5a9f..c2d4e59 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -234,7 +234,7 @@
 %
 % Test files are written as standalone \TeX{} documents using the |regression-test.tex| setup file; documentation on writing these tests is discussed in Section~\ref{sec:writing-tests}.
 %
-% The |l3build.lua| script is not designed to be executed directly; each package will define its own |build.lua| script as a driver file which both sets variables (such as the name of the package) and then calls the main |l3build.lua| script internally.
+% Each package will define its own |build.lua| configuration file which both sets variables (such as the name of the package) and may also provide custom functions.
 %
 % \pagebreak[2]
 % A standard package layout might look something like the following:
@@ -560,9 +560,7 @@
 %
 % \begin{figure}[!b]
 %   \begin{lstlisting}[frame=single,language={[5.2]Lua},gobble = 6]
-%     #!/usr/bin/env texlua
-%
-%     -- Build script for breqn
+%     -- Build configuration for breqn
 %
 %     module = "breqn"
 %
@@ -570,11 +568,8 @@
 %     excludefiles = {"*/breqn-abbr-test.pdf",
 %                     "*/eqbreaks.pdf"}
 %     unpackopts  = "-interaction=batchmode"
-%
-%     kpse.set_program_name("kpsewhich")
-%     dofile(kpse.lookup("l3build.lua"))
 %   \end{lstlisting}
-% \caption{The build script for the \pkg{breqn} package.}
+% \caption{The build configuration for the \pkg{breqn} package.}
 % \label{fig:breqn}
 % \end{figure}
 %
@@ -584,8 +579,6 @@
 %
 % \begin{figure}[p]
 %   \begin{lstlisting}[frame=single,language={[5.2]Lua},gobble = 6]
-%     #!/usr/bin/env texlua
-%
 %     -- Build script for LaTeX3 "l3packages" files
 %
 %     -- Identify the bundle: there is no module as this is the "driver"
@@ -596,8 +589,8 @@
 %
 %     -- Load the common build code: this is the one place that a path
 %     -- needs to be hard-coded
-%     dofile (maindir .. "/l3build/l3build-config.lua")
-%     dofile (maindir .. "/l3build/l3build.lua")
+%     dofile(maindir .. "/l3build/l3build-config.lua")
+%     dofile(maindir .. "/l3build/l3build.lua")
 %   \end{lstlisting}
 % \caption{The build script for the \pkg{l3packages} bundle.}
 % \label{fig:bundle}
@@ -605,8 +598,6 @@
 %
 % \begin{figure}[p]
 %   \begin{lstlisting}[frame=single,language={[5.2]Lua},gobble = 6]
-%     #!/usr/bin/env texlua
-%
 %     -- Build script for LaTeX3 "xparse" files
 %
 %     -- Identify the bundle and module:
@@ -619,28 +610,13 @@
 %
 %     -- Load the common build code: this is the one place that a path
 %     -- needs to be hard-coded
-%     dofile (maindir .. "/l3build/l3build-config.lua")
-%     dofile (maindir .. "/l3build/l3build.lua")
+%     dofile(maindir .. "/l3build/l3build-config.lua")
+%     dofile(maindir .. "/l3build/l3build.lua")
 %   \end{lstlisting}
 % \caption{The build script for the \pkg{xparse} module.}
 % \label{fig:module}
 % \end{figure}
 %
-% \begin{figure}[p]
-%   \begin{lstlisting}[frame=single,gobble = 6]
-%     @echo off
-%     texlua build.lua %*
-%   \end{lstlisting}
-% \caption{Windows batch file wrapper for running the build process.}
-% \label{fig:batch}
-% \end{figure}
-%
-% Under a Unix-like platform, you may wish to run `|chmod +x build.lua|' on these files, which allows a simpler command line use. Instead of writing\\
-% \hspace*{2\parindent}|texlua build.lua check|\\ for example, you would simply write\\
-% \hspace*{2\parindent}|./build.lua check|\\
-% instead. (Or even omit the |./| depending on your path settings.)
-% Windows users can achieve a similar effect by creating a file |build.bat| as show in Figure~\ref{fig:batch}.
-%
 % \subsection{Variables}
 %
 % This section lists all variables defined in the |l3build.lua| script that are available for customisation.