diff options
Diffstat (limited to 'macros/latex/contrib/l3build/l3build.dtx')
-rw-r--r-- | macros/latex/contrib/l3build/l3build.dtx | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/macros/latex/contrib/l3build/l3build.dtx b/macros/latex/contrib/l3build/l3build.dtx index e02dfd6f53..28b06030c9 100644 --- a/macros/latex/contrib/l3build/l3build.dtx +++ b/macros/latex/contrib/l3build/l3build.dtx @@ -251,7 +251,7 @@ % }^^A % } % -% \date{Released 2024-01-09} +% \date{Released 2024-01-18} % % \maketitle % \tableofcontents @@ -371,17 +371,14 @@ % \item |--config| (|-c|) Configuration(s) to use for testing % \item |--date| Date to use when tagging data % \item |--debug| Runs the target in debug mode (not supported by all targets) -% \item |--dirty| Skip cleaning up of the test area +% \item |--dirty| Skips cleaning up of the test area % \item |--dry-run| Runs the \texttt{install} target but does not copy % any files: simply lists those that would be installed % \item |--email| Sets the email address for CTAN upload % \item |--engine| (|-e|) Sets the engine to use for testing % \item |--epoch| Sets the epoch for typesetting and testing -% \item |--file| (|-F|) Take the upload announcement from the given file +% \item |--file| (|-F|) Takes the upload announcement from the given file % \item |--first| Name of the first test to run -% \item |--force| (|-f|) Force checks to run even if sanity -% checks fail, \emph{e.g.}~when |--engine| is not given in -% \var{checkengines} % \item |--full| Instructs the \texttt{install} target to include the % \texttt{doc} and \texttt{source} trees % \item |--halt-on-error| (|-H|) Specifies that checks @@ -390,12 +387,14 @@ % \item |--last| Name of the last test to run % \item |--message| (|-m|) Text for upload announcement % \item |--quiet| (|-q|) Suppresses output from unpacking -% \item |--rerun| Run tests without unpacking/set up +% \item |--rerun| Runs tests without unpacking/set up % \item |--show-log-on-error| To be used in addition to \texttt{--halt-on-error} and results % in the full \texttt{.log} file of a failed test to be shown on the console -% \item |--show-saves| (|-S|) When tests fail, print the \texttt{l3build save} commands needed +% \item |--show-saves| (|-S|) When tests fail, prints the \texttt{l3build save} commands needed % to regenerate the tests assuming that the failures were false negatives. -% \item |--shuffle| Shuffle the order in which tests run +% \item |--shuffle| Shuffles the order in which tests run +% \item |--stdengine| (|-s|) Run tests only with the standard engine (which can vary between +% configurations) % \item |--texmfhome| Sets the location of the user tree for installing % \end{itemize} % @@ -457,7 +456,7 @@ % line option |--engine| (or |-e|) has been given to limit % testing to a single engine. Normally testing is preceded by unpacking % source files and copying the result plus any additional support to the -% test directory: this may be skipped using the |-s| option. +% test directory: this may be skipped using the |--rerun| (|-r|) option. % \end{buildcmd} % % \begin{buildcmd}{clean} @@ -591,7 +590,9 @@ % \end{buildcmd} % % \begin{buildcmd}{tag [\meta{tag name}]} -% Apply the Lua |update_tag()| function to modify the contents of files specified by |tagfiles| to update the `release tag' (or package version) and date. +% Applies the Lua |update_tag()| function to modify the contents of all the files +% specified by |tagfiles|; this function updates the `release tag' (or package version) +% and date. % The tag is given as the optional command line argument \meta{tag name} and the date using % |--date| (or |-d|). If not given, the date will default to the current date in % ISO format (YYYY-MM-DD). If no \meta{tag name} is given, the tag will default to |nil|. @@ -981,13 +982,14 @@ % \cs{BEGINTEST}\marg{title} \dots \cs{ENDTEST} is an environment form of % \cs{TEST}, allowing verbatim material, \emph{etc.} to appear. % \item -% \cs{SHOWFILE}\marg{filename} (\eTeX{} only) Shows the content of +% \cs{SHOWFILE}\marg{filename} (\eTeX{} only) shows the content of % \meta{filename}. % \item % \cs{ASSERT}\marg{arg_1}\marg{arg_2} and \cs{ASSERTSTR}\marg{arg_1}\marg{arg_2} -% Asserts if the full expansion of \meta{arg_1} and \meta{arg_2} are the same: -% the \cs{ASSERT} function is token-based, -% the \cs{ASSERTSTR} works on a string basis. +% Test if the full expansion of \meta{arg_1} and \meta{arg_2} are the same: +% on a token basis in \cs{ASSERT} and on a string basis in \cs{ASSERTSTR}. +% Depending on the outcome, record either \texttt{PASSED} or \texttt{FAILED} +% in the \texttt{.log}. % \end{itemize} % An example of some of these commands is shown following. % \begin{Verbatim} @@ -1671,7 +1673,6 @@ % \var{epoch} & String \\ % \var{file} & string \\ % \var{first} & Boolean \\ -% \var{force} & Boolean \\ % \var{full} & Boolean \\ % \var{halt-on-error} & Boolean \\ % \var{help} & Boolean \\ @@ -1680,6 +1681,7 @@ % \var{quiet} & Boolean \\ % \var{rerun} & Boolean \\ % \var{shuffle} & Boolean \\ +% \var{stdengine} & Boolean \\ % \var{texmfhome} & String \\ % \bottomrule % \end{tabular} |