[latex3-commits] [git/LaTeX3-latex3-latex2e] develop: Dummy defs for trace package support added (b70d9463)
Frank Mittelbach
frank.mittelbach at latex-project.org
Fri Aug 30 19:54:49 CEST 2019
Repository : https://github.com/latex3/latex2e
On branch : develop
Link : https://github.com/latex3/latex2e/commit/b70d9463a335f8879afb1ae3d6b7dcca13584616
>---------------------------------------------------------------
commit b70d9463a335f8879afb1ae3d6b7dcca13584616
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Fri Aug 30 19:54:49 2019 +0200
Dummy defs for trace package support added
>---------------------------------------------------------------
b70d9463a335f8879afb1ae3d6b7dcca13584616
base/changes.txt | 5 +++++
base/doc/ltnews30.tex | 13 +++++++++++++
base/lterror.dtx | 44 +++++++++++++++++++++++++++++++++++++++++---
3 files changed, 59 insertions(+), 3 deletions(-)
diff --git a/base/changes.txt b/base/changes.txt
index 9fcc430d..36dfda62 100644
--- a/base/changes.txt
+++ b/base/changes.txt
@@ -4,6 +4,11 @@ completeness or accuracy and it contains some references to files that
are not part of the distribution.
=======================================================================
+2019-08-30 Frank Mittelbach <Frank.Mittelbach at latex-project.org>
+
+ * lterror.dtx (subsection{Tracing}):
+ Dummy defs for \conditionally at traceon and \conditionally at traceoff added
+
2019-08-22 Frank Mittelbach <Frank.Mittelbach at latex-project.org>
* ltxref.dtx (subsection{Cross Referencing}):
diff --git a/base/doc/ltnews30.tex b/base/doc/ltnews30.tex
index 17848778..ff7f0ab2 100644
--- a/base/doc/ltnews30.tex
+++ b/base/doc/ltnews30.tex
@@ -250,6 +250,19 @@ action has been made the default so that one can simply hit enter
instead of having to write \verb=\table\bye=.
+\subsection{For developers: \pkg{trace} package support by the kernel}
+
+The \pkg{trace} package implements the commands \cs{traceon}
+and \cs{traceoff} that work similar to \cs{tracingall} but skip
+certain code blocks that produce a lot of tracing output being of no
+interest during debugging (for example loading a font).
+Code blocks that should be hidden during tracing need
+to be surrounded by the macros \cs{conditionally at traceoff}
+and \cs{contionally at traceon}.
+
+The \LaTeX{} kernel now provides dummy definitions for these two
+commands so that package writers can use them in their packages
+regardless of \pkg{trace} being loaded or not.
diff --git a/base/lterror.dtx b/base/lterror.dtx
index c568d2c9..3f6c4369 100644
--- a/base/lterror.dtx
+++ b/base/lterror.dtx
@@ -32,7 +32,7 @@
%<*driver>
% \fi
\ProvidesFile{lterror.dtx}
- [2018/08/05 v1.2p LaTeX Kernel (errors)]
+ [2019/08/30 v1.2q LaTeX Kernel (errors)]
% \iffalse
\documentclass{ltxdoc}
\GetFileInfo{lterror.dtx}
@@ -87,7 +87,7 @@
% \changes{v1.2p}{2016/10/15}
% {Require e\TeX{}}
%
-% \section{Error handling}
+% \section{Error handling and tracing}
%
% This section defines \LaTeX's error commands.
%
@@ -738,7 +738,6 @@ Type H <return> for immediate help.}%
% out, since we decided to use catcode 15 instead.
% \begin{macrocode}
%\def\@invalidchar{\@latex at error{Invalid character in input}\@ehc}
-%</2ekernel>
% \end{macrocode}
% \end{macro}
%
@@ -759,5 +758,44 @@ Type H <return> for immediate help.}%
% In output routine, caused by a float environment or
% |\marginpar| occurring in inner vertical mode.
%
+%
+% \subsection{Tracing}
+%
+% The \texttt{trace} package implements the commands \cs{traceon}
+% and \cs{traceoff} that work similar to \cs{tracingall} but skip
+% certain code blocks that produce a lot of tracing output being of no
+% interest during debugging (for example loading a font).
+% Code blocks that should be hidden during tracing need
+% to be surrounded by the macros \cs{conditionally at traceoff}
+% and \cs{contionally at traceon}.
+%
+% For the kernel code the \texttt{trace} package then redefines a
+% number of macros to include this tracing support.
+%
+% However, in order to allow any macro package to react to
+% \cs{traceon} we also provide dummy definitions for the two
+% commands in the kernel so that they can be used by external
+% packages without the
+% need to distinguish between \texttt{trace} being loaded or not.
+%
+
+% \begin{macro}{\conditionally at traceon}
+% \changes{v1.2q}{2019/08/30}{Macro added}
+% \begin{macro}{\conditionally at traceoff}
+% \changes{v1.2q}{2019/08/30}{Macro added}
+% These are only dummy definitions. For details see the
+% \texttt{trace} package.
+% \begin{macrocode}
+\let\conditionally at traceon\@empty
+\let\conditionally at traceoff\@empty
+% \end{macrocode}
+% \end{macro}
+% \end{macro}
+%
+%
+% \begin{macrocode}
+%</2ekernel>
+% \end{macrocode}
+%
%\Finale
\endinput
More information about the latex3-commits
mailing list