[latex3-commits] [git/LaTeX3-latex3-latex3] master: Document that LuaTeX's clock only measures CPU time and not real time (1daf93d)

[Bruno Le Floch]

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

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

commit 1daf93d456c8a61b409737894d94c1b6a4a171ba
Author: Bruno Le Floch <bruno at le-floch.fr>
Date:   Wed May 22 09:18:56 2019 +0200

    Document that LuaTeX's clock only measures CPU time and not real time


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

1daf93d456c8a61b409737894d94c1b6a4a171ba
 l3experimental/l3benchmark/l3benchmark.dtx |    6 ++++--
 l3kernel/l3luatex.dtx                      |    6 ++++--
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/l3experimental/l3benchmark/l3benchmark.dtx b/l3experimental/l3benchmark/l3benchmark.dtx
index 614e640..7523abd 100644
--- a/l3experimental/l3benchmark/l3benchmark.dtx
+++ b/l3experimental/l3benchmark/l3benchmark.dtx
@@ -66,8 +66,10 @@
 %     \cs{sys_timer:}
 %   \end{syntax}
 %   Expands to the current value of the engine's timer clock, a
-%   non-negative integer.  In engines without clock support this
-%   expands to $0$.
+%   non-negative integer.  In engines without clock support this expands
+%   to $0$ after an error.  In \LuaTeX{} only the CPU time is measured,
+%   while in other engines real time is measured (including time waiting
+%   for user input).
 % \end{function}
 %
 % \section{Benchmark}
diff --git a/l3kernel/l3luatex.dtx b/l3kernel/l3luatex.dtx
index aaf49e2..bf83b7c 100644
--- a/l3kernel/l3luatex.dtx
+++ b/l3kernel/l3luatex.dtx
@@ -137,8 +137,10 @@
 %   \begin{syntax}
 %     |l3kernel.elapsedtime()|
 %   \end{syntax}
-%  Returns the time in \meta{scaled seconds} since the start of the \TeX{} run
-%  or since |l3kernel.resettimer| was issued.
+%   Returns the CPU time in \meta{scaled seconds} since the start of the
+%   \TeX{} run or since |l3kernel.resettimer| was issued.  This only
+%   measures the time used by the CPU, not the real time, e.g., waiting
+%   for user input.
 % \end{function}
 %
 % \begin{function}{l3kernel.filemdfivesum}