From 96d1ff57755cb4a61f46403b98ebc65cc3027217 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Thu, 10 Jun 2021 14:20:27 -0400 Subject: [PATCH] more doc --- src/tef/Sidekick_tef.mli | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/tef/Sidekick_tef.mli b/src/tef/Sidekick_tef.mli index 33168a57..91cbf736 100644 --- a/src/tef/Sidekick_tef.mli +++ b/src/tef/Sidekick_tef.mli @@ -2,9 +2,23 @@ (** {1 Tracing Event Format} A nice profiling format based on json, useful for visualizing what goes on. - See https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/ + It provides a backend for {!Sidekick_util.Profile} so that + profiling probes will emit TEF events. + + Profiling is enabled if {!setup} is called, and if + the environment variable "TEF" is set to "1" or "true". + The trace is emitted in the file "trace.json.gz" in the directory + where the solver is launched; you can open it in + chrome/chromium at "chrome://tracing". + + {{: https://github.com/wolfpld/tracy} Tracy} can import (uncompressed) + trace files with a nice native trace explorer. + + See {{: https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/} + the documentation of TEF} *) val setup : unit -> unit +(** Install the TEF logger as a profiling backend. *) val teardown : unit -> unit