summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Pickering <matthewtpickering@gmail.com>2019-05-29 17:15:48 +0100
committerMatthew Pickering <matthewtpickering@gmail.com>2019-05-30 10:09:05 +0100
commit1a2c433764204f9f23eff696b45badbc26e5875a (patch)
treec8752cbae5c3bcefbeacf10bdcccde5148382959
parent2d2aa2031b9abc3bff7b5585ab4201948c8bba7d (diff)
downloadhaskell-wip/eventlog-docs.tar.gz
Eventlog: Document the fact timestamps are nanosecondswip/eventlog-docs
[skip ci]
-rw-r--r--docs/users_guide/runtime_control.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 0048a51837..c573576972 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -1095,6 +1095,10 @@ When the program is linked with the :ghc-flag:`-eventlog` option
`ghc-events <http://hackage.haskell.org/package/ghc-events>`__
package.
+ Each event is associated with a timestamp which is the number of
+ nanoseconds since the start of executation of the running program.
+ This is the elapsed time, not the CPU time.
+
.. rts-flag:: -ol ⟨filename⟩
:default: :file:`<program>.eventlog`