[latex3-commits] [l3svn] 20/20: l3build: Document 'utility' functions [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 44d3e0349f993f538cb6d654fb55e5fae88f02de
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Fri Apr 14 22:36:23 2017 +0100

    l3build: Document 'utility' functions [ci skip]
    
    This covers the first 'part' of l3build (and matches the lines
    refactored in commits to-date).
---
 l3build/l3build.dtx |  127 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 127 insertions(+)

diff --git a/l3build/l3build.dtx b/l3build/l3build.dtx
index 8d46d54..ada0468 100644
--- a/l3build/l3build.dtx
+++ b/l3build/l3build.dtx
@@ -1104,6 +1104,133 @@
 %   \label{fig:PDF}
 % \end{figure}
 %
+% \section{Lua interfaces}
+%
+% Whilst for the majority of users the simple variable-based control methods
+% outlined above will suffice, for more advanced applications there will be
+% a need to adjust behavior by using interfaces within the Lua code. This
+% section details the global variables and functions provided.
+%
+% \subsection{Global variables}
+%
+% \begin{variable}{options}
+%   The |options| table holds the values passed to \pkg{l3build} at the
+%   command line. The possible entries in the table are given in the table
+%   below.
+%   \begin{center}
+%   \begin{tabular}{ll}
+%     \toprule
+%     Entry & Type \\
+%     \midrule
+%       \var{date}        & String  \\
+%       \var{engine}      & Table   \\
+%       \var{files}       & Table   \\
+%       \var{halt}        & Boolean \\
+%       \var{help}        & Boolean \\
+%       \var{pdf}         & Boolean \\
+%       \var{quiet}       & Boolean \\
+%       \var{release}     & String  \\
+%       \var{testfiledir} & String  \\
+%     \bottomrule
+%     \end{tabular}
+%   \end{center}
+% \end{variable}
+%
+% \subsection{Utility functions}
+%
+% The utility functions are largely focussed on file operations, though a small
+% number of others are provided. File paths should be given in Unix style
+% (using |/| as a path separator). File operations take place relative to the
+% path from which \pkg{l3build} is called. File operation syntax is largely
+% modelled on Unix command line commands but reflect the need to work on
+% Windows in a flexible way.
+%
+% \begin{function}{cleandir()}
+%   \begin{syntax}
+%     |cleandir(|\meta{dir}|)|
+%   \end{syntax}
+%   Removes any content within the \meta{dir}; returns an error level.
+% \end{function}
+%
+% \begin{function}{cp()}
+%   \begin{syntax}
+%     |cp(|\meta{glob}, \meta{source}, \meta{destination}|)|
+%   \end{syntax}
+%   Copies files matching the \meta{glob} from the \meta{source} directory
+%   to the \meta{destination}; returns an error level.
+% \end{function}
+%
+% \begin{function}{direxists()}
+%   \begin{syntax}
+%     |direxists(|\meta{dir}|)|
+%   \end{syntax}
+%   Tests if the \meta{dir} exists; returns a boolean value.
+% \end{function}
+%
+% \begin{function}{fileexists()}
+%   \begin{syntax}
+%     |fileexists(|\meta{file}|)|
+%   \end{syntax}
+%   Tests if the \meta{file} exists; returns a boolean value.
+% \end{function}
+%
+% \begin{function}{filelist()}
+%   \begin{syntax}
+%     |filelist(|\meta{path}, \oarg{glob}|)|
+%   \end{syntax}
+%   Returns a table containing all of the files with the \meta{path}
+%   which match the \meta{glob}; if the latter is absent returns a list of
+%   all files in the \meta{path}.
+% \end{function}
+%
+% \begin{function}{mkidr()}
+%   \begin{syntax}
+%     |mkdir(|\meta{dir}|)|
+%   \end{syntax}
+%   Creates the \meta{dir}; returns an error level.
+% \end{function}
+%
+% \begin{function}{relpath()}
+%   \begin{syntax}
+%     |relpath(|\meta{target}, \meta{source}|)|
+%   \end{syntax}
+%   Returns a string which gives the location of the \meta{target} directory
+%   relative to the \meta{source}.
+% \end{function}
+%
+% \begin{function}{ren()}
+%   \begin{syntax}
+%     |ren(|\meta{dir}, \meta{source}, \meta{destination}|)|
+%   \end{syntax}
+%   Renames the \meta{source} file to the \meta{destination} name within
+%   the \meta{dir}; returns an error level.
+% \end{function}
+%
+% \begin{function}{rm()}
+%   \begin{syntax}
+%     |rm(|\meta{dir}, \meta{glob}|)|
+%   \end{syntax}
+%   Removes files in the \meta{dir} matching the \meta{glob}; returns an
+%   error level.
+% \end{function}
+%
+% \begin{function}{run()}
+%   \begin{syntax}
+%     |run(|\meta{dir}, \meta{cmd}|)|
+%   \end{syntax}
+%   Executes the \meta{cmd}, starting it in the \meta{dir}; returns an
+%   error level.
+% \end{function}
+%
+% \begin{function}{unix_to_win()}
+%   \begin{syntax}
+%     |unix_to_win(|\meta{path}|)|
+%   \end{syntax}
+%   Returns a string comprising the \meta{path} with |/| characters replaced
+%   by |\\|  and thus suitable for use with Windows-specific commands which
+%   require this form of path.
+% \end{function}
+%
 % \end{documentation}
 %
 % \begin{implementation}

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