[latex3-commits] [git/LaTeX3-latex3-l3build] direct-copy: Document tdsdirs (3d0d397)

[Joseph Wright]

Repository : https://github.com/latex3/l3build
On branch  : direct-copy
Link       : https://github.com/latex3/l3build/commit/3d0d3972e6f8d2877c7254c688cc34088f775389

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

commit 3d0d3972e6f8d2877c7254c688cc34088f775389
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Wed Dec 8 10:32:01 2021 +0000

    Document tdsdirs


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

3d0d3972e6f8d2877c7254c688cc34088f775389
 l3build.dtx | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/l3build.dtx b/l3build.dtx
index 41ff08d..27269f2 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -161,6 +161,7 @@
 \luavarset{manifestfile}        {"MANIFEST.md"} {Filename to use for the manifest file}
 \luavarseparator
 \luavarset{tdslocations}{\{ \}}{Map for non-standard file installations}
+\luavarset{tdsdirs}{\{ \}}{List of ready-to-use source locations}
 \luavarseparator
 \luavarset{uploadconfig}        {\meta{table}} {Metadata to describe the package for CTAN (see Table~\ref{tab:upload-setup})}
 \luavarset{uploadconfig.pkg}{ctanpkg}{Name of the CTAN package}
@@ -774,6 +775,22 @@
 % A series of example layouts and matching |build.lua| files are available from
 % \url{https://github.com/latex3/l3build/tree/master/examples}.
 %
+% For more complex layouts in which sources are laid out in TDS format and
+% should be used directly, the table \var{tdsdirs} is available. Each entry
+% is a source directory and the matching installation target, for example
+% \begin{Verbatim}
+%   tdsdirs = {sources = "tex"}
+% \end{Verbatim}
+%  This would enable a directory \texttt{sources} in the development area to
+%  be used for testing and typesetting, and for it to be installed into the
+%  \texttt{tex} tree when building a release. When this method is used, the
+%  sources are \emph{not} copied into the local tree: like \var{texmfdir},
+%  they are added directly to the areas accessible during a testing or
+%  typesetting run. When using this approach, the files listed in
+%  \var{typesetfiles} \emph{must} still be included in \var{docfiles}:
+%  they have to be directly visible to \pkg{l3build}, not found by
+%  \texttt{kpsewhich} searching.
+%
 % \subsection{Non-standard formats/binaries}
 %
 % The standard approach used by \pkg{l3build} is to use a combination