[latex3-commits] [git/LaTeX3-latex3-latex3] master: Actually update docs (cecb47ad3)

Joseph Wright joseph.wright at morningstar2.co.uk
Tue Oct 8 09:47:14 CEST 2019


Repository : https://github.com/latex3/latex3
On branch  : master
Link       : https://github.com/latex3/latex3/commit/cecb47ad345dcb7b16176fe7a26ea2e5cdf5cf60

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

commit cecb47ad345dcb7b16176fe7a26ea2e5cdf5cf60
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date:   Tue Oct 8 08:47:14 2019 +0100

    Actually update docs


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

cecb47ad345dcb7b16176fe7a26ea2e5cdf5cf60
 l3kernel/l3basics.dtx | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/l3kernel/l3basics.dtx b/l3kernel/l3basics.dtx
index a6b92aff8..24a8e3a6d 100644
--- a/l3kernel/l3basics.dtx
+++ b/l3kernel/l3basics.dtx
@@ -1293,6 +1293,45 @@
 %   \end{texnote}
 % \end{function}
 %
+% \subsection{Debugging support}
+%
+% \begin{function}[added = 2017-07-16, updated = 2017-08-02]{\debug_on:n, \debug_off:n}
+%   \begin{syntax}
+%     \cs{debug_on:n} |{| \meta{comma-separated list} |}|
+%     \cs{debug_off:n} |{| \meta{comma-separated list} |}|
+%   \end{syntax}
+%   Turn on and off within a group various debugging code, some of which
+%   is also available as \pkg{expl3} load-time options.  The items that
+%   can be used in the \meta{list} are
+%   \begin{itemize}
+%     \item \texttt{check-declarations} that checks all \pkg{expl3}
+%       variables used were previously declared and that local/global
+%       variables (based on their name or on their first assignment) are
+%       only locally/globally assigned;
+%     \item \texttt{check-expressions} that checks integer, dimension,
+%       skip, and muskip expressions are not terminated prematurely;
+%     \item \texttt{deprecation} that makes soon-to-be-deprecated commands produce errors;
+%     \item \texttt{log-functions} that logs function definitions;
+%     \item \texttt{all} that does all of the above.
+%   \end{itemize}
+%   Providing these as switches rather than options allows testing code
+%   even if it relies on other packages: load all other packages, call
+%   \cs{debug_on:n}, and load the code that one is interested in
+%   testing.  These functions can only be used in \LaTeXe{} package mode
+%   loaded with \texttt{enable-debug} or another option implying it.
+% \end{function}
+%
+% \begin{function}[added = 2017-11-28]{\debug_suspend:, \debug_resume:}
+%   \begin{syntax}
+%     \cs{debug_suspend:} \ldots{} \cs{debug_resume:}
+%   \end{syntax}
+%   Suppress (locally) errors and logging from \texttt{debug} commands,
+%   except for the \texttt{deprecation} errors or warnings.  These pairs
+%   of commands can be nested.  This can be used around pieces of code
+%   that are known to fail checks, if such failures should be ignored.
+%   See for instance \pkg{l3coffins}.
+% \end{function}
+%
 % \end{documentation}
 %
 % \begin{implementation}





More information about the latex3-commits mailing list