[latex3-commits] [latex3/l3build] main: more accurate |clean| description (5dfcaea)

[github at latex-project.org]

Repository : https://github.com/latex3/l3build
On branch  : main
Link       : https://github.com/latex3/l3build/commit/5dfcaea6d7040cff1f6a2b48f343126573a8a188

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

commit 5dfcaea6d7040cff1f6a2b48f343126573a8a188
Author: LAURENS Jérôme <jerome.laurens at u-bourgogne.fr>
Date:   Fri Jun 28 21:42:16 2024 +0200

    more accurate |clean| description


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

5dfcaea6d7040cff1f6a2b48f343126573a8a188
 l3build.dtx | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/l3build.dtx b/l3build.dtx
index ed251b8..12d662e 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -460,9 +460,19 @@
 % \end{buildcmd}
 %
 % \begin{buildcmd}{clean}
-% This command removes all temporary files used for package bundling and regression testing.
-% In the standard layout, these are all files within the directories defined by \var{localdir}, \var{testdir}, \var{typesetdir} and \var{unpackdir}, as well as all files defined in the \var{cleanfiles} variable in the same directory as the script.
-% The defaults are |.pdf| files from typesetting (|doc|) and |.zip| files from bundling (|ctan|).
+% This target is meant as preparation for other targets, for example |ctan|.
+% It removes the contents of \var{distribdir} and all temporary files used for package bundling and regression testing.
+% These are all files within the directories \var{unpackdir}, \var{testdir}, \var{typesetdir} and \var{localdir}.
+% In addition, all the files in \var{maindir} (the directory of |build.lua| in the standard layout),
+% \var{sourcefiledir} and \var{docfiledir} are removed when matched by \var{cleanfiles}
+% but not by \var{sourcefiles}.
+% In a standard way are removed |.log| and |.pdf| files from the |doc| target and
+% |.zip| files from the |ctan| target.
+%
+% When applied to a bundle, the |clean| target is first applied to each
+% embedded modules (listed in |modules|). 
+% In addition, all the files in the directory of |build.lua| are removed
+% when matched by \var{cleanfiles}, while ignoring \var{sourcefiles}. Finally |ctandir| and |tdsdir| are removed.
 % \end{buildcmd}
 %
 %